PHPackages                             rsgrinko/outline-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. rsgrinko/outline-api-client

ActiveLibrary[API Development](/categories/api)

rsgrinko/outline-api-client
===========================

Simple API client for Outline

1.0.3(2y ago)127MITPHPPHP >=7.4

Since Nov 14Pushed 2y ago1 watchersCompare

[ Source](https://github.com/rsgrinko/outline-api-client)[ Packagist](https://packagist.org/packages/rsgrinko/outline-api-client)[ RSS](/packages/rsgrinko-outline-api-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (5)Used By (0)

Outline API Client
==================

[](#outline-api-client)

Simple API client for [OutlineVPN](https://getoutline.org/ru/).

Installation
------------

[](#installation)

Install the latest version with

```
$ composer require rsgrinko/outline-api-client
```

Requirements
------------

[](#requirements)

PHP >= 7.4

How to use
----------

[](#how-to-use)

### Usage API Client

[](#usage-api-client)

```
require 'vendor/autoload.php';

use rsgrinko\Outline\Outline;

try {
    $outlineObject = new Outline('https://127.0.0.1:1234/EUwl3A2e-Af6cNeQs');
    $clientObject  = $outlineObject->getClientObject();
    // Get an array of all server keys
    $keysList = $clientObject->getKeys();

    // Create new key
    $key = $clientObject->create();

    // Rename exist key.
    $clientObject->setName($key['id'], 'My new key');

    // Set transfer data limit for key (in bytes)
    $clientObject->setLimit($key['id'], 5 * 1024 * 1024);

    // Remove key limit
    $clientObject->deleteLimit($key['id']);

    // Delete key
    $clientObject->delete($key['id']);

    // Get an array of used traffic for all keys
    $transferData = $clientObject->metricsTransfer();
} catch (Throwable $t) {
    // Handle exception...
}
```

### Usage OutlineVPN key wrapper

[](#usage-outlinevpn-key-wrapper)

Interaction with an existing key

```