https://github.com/m1guelpf/php-fly-api

A PHP Client for the Fly.io API
https://github.com/m1guelpf/php-fly-api

client fly fly-io guzzle php

Last synced: 3 months ago
JSON representation

A PHP Client for the Fly.io API

• Host: GitHub
• URL: https://github.com/m1guelpf/php-fly-api
• Owner: m1guelpf
• License: mit
• Created: 2017-10-22T17:16:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-11-16T18:46:33.000Z (about 5 years ago)
• Last Synced: 2024-05-02T05:09:40.712Z (9 months ago)
• Topics: client, fly, fly-io, guzzle, php
• Language: PHP
• Homepage:
• Size: 13.7 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PHP Fly.io API Client

[![Latest Version on Packagist](https://img.shields.io/packagist/v/m1guelpf/fly-api.svg?style=flat-square)](https://packagist.org/packages/m1guelpf/fly-api)

[![Software License](https://img.shields.io/github/license/m1guelpf/php-fly-api.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://img.shields.io/travis/m1guelpf/php-fly-api/master.svg?style=flat-square)](https://travis-ci.org/m1guelpf/php-fly-api)

[![Total Downloads](https://img.shields.io/packagist/dt/m1guelpf/fly-api.svg?style=flat-square)](https://packagist.org/packages/m1guelpf/fly-api)

This package makes it easy to interact with [the Fly.io API](https://fly.io/docs/api/).

## Requirements

This package requires PHP >= 5.5.

## Installation

You can install the package via composer:

``` bash

composer require m1guelpf/fly-api

```

## Usage

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

``` php

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

```

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

``` php

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

$fly->connect('YOUR_FLY_API_TOKEN');

```

### Get Hostnames

``` php

$fly->getHostnames($slug);

```

### Create Hostname

``` php

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

```

### Get Hostname

``` php

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

```

### Create Backend

``` php

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

```

### Create Rule

``` php

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

```

### Get the Guzzle Client

``` php

$fly->getClient();

```

### Set the Guzzle Client

``` php

$client = new \GuzzleHttp\Client(); // Example Guzzle client

$fly->setClient($client);

```

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

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash

$ composer test

```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## Credits

- [Miguel Piedrafita](https://github.com/m1guelpf)

- [All Contributors](../../contributors)

## License

The MIT License. Please see [License File](LICENSE.md) for more information.