m1guelpf/fly-api

PHP Client for the Fly API

Fund package maintenance!
m1guelpf

v1.0.2 2017-11-28 10:32 UTC

This package is auto-updated.

Last update: 2024-10-17 05:51:46 UTC


README

Latest Version on Packagist Software License Build Status Total Downloads

This package makes it easy to interact with the Fly.io API.

Requirements

This package requires PHP >= 5.5.

Installation

You can install the package via composer:

composer require m1guelpf/fly-api

Usage

You must pass a Guzzle client and the API token to the constructor of M1guelpf\FlyAPI\Fly.

$fly = new \M1guelpf\FlyAPI\Fly('YOUR_FLY_API_TOKEN');

or you can skip the token and use the connect() method later

$fly = new \M1guelpf\FlyAPI\Fly();

$fly->connect('YOUR_FLY_API_TOKEN');

Get Hostnames

$fly->getHostnames($slug);

Create Hostname

$fly->createHostname($slug, $hostname);

Get Hostname

$fly->getHostname($slug, $hostname);

Create Backend

$fly->createBackend($slug, $name, $type, $settings);

Create Rule

$fly->createRule($slug, $hostname, $backend_id, $action_type, $path, $priority, $path_replacement);

Get the Guzzle Client

$fly->getClient();

Set the Guzzle Client

$client = new \GuzzleHttp\Client(); // Example Guzzle client
$fly->setClient($client);

where $client is an instance of \GuzzleHttp\Client.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email soy@miguelpiedrafita.com instead of using the issue tracker.

Credits

License

The MIT License. Please see License File for more information.