library lxcpapi

lcherone/lxcpapi

LXC Web panel REST v1 API Client

LXC Panel REST API PHP Client

About:, _(*1)

This php composer package provides a simple object orientated way to interact with the LXC Web Panel v1 REST API., _(*2)

Author:, _(*3)

@lcherone, _(*4)

Setup:, _(*5)

Using composer add the package to your project:, _(*6)

composer require lcherone/lxcpapi, _(*7)

Initializing the client, _(*8)

<?php
require 'vendor/autoload.php';

/**
 * Initialize the API client class
 */
$api = new lcherone\lxcpapi\APIClient([
    'base_uri'   => 'http://lxcpanel.example.com:5000',
    'api_key'    => 'api-key-generated-in-panel'
]);
?>

Making calls:

To interact with the API its as simple as calling a class method or property, endpoints are dynamically loaded when traversed to., _(*9)

Containers

Get, _(*10)

$containers = $api->containers->get();

Get (container), _(*11)

$container = $api->containers->get('container_name');

Create, _(*12)

$container = $api->containers->create('my-container', 'sshd');

Update, _(*13)

$container = $api->containers->update('my-container', 'start');

Delete, _(*14)

$container = $api->containers->delete('my-container');

Clone/Copy, _(*15)

$container = $api->containers->copy('my-container');

Tokens

Create, _(*16)

$tokens = $api->tokens->create('some-fancy-api-key', 'API Token');

Delete, _(*17)

$tokens = $api->tokens->delete('some-fancy-api-key');