Please note: this project is still in its early stages and the API may be subject to change.

composer require hypernode/api-client

The API client is HTTP client agnostic, which means that it's compatible with any HTTP client implementing PSR-18 interface.

Popular HTTP client implementations are: Guzzle and Symfony HTTP Client.

A full list of implementations, can be found here.

Each Hypernode has an API token associated with it, you can use that to talk to the API directly. You can find the token in /etc/hypernode/hypernode_api_token. For API tokens with special permissions please contact support@hypernode.com.

use Hypernode\Api\HypernodeClientFactory;

require_once 'vendor/autoload.php';

$client = HypernodeClientFactory::create(getenv('HYPERNODE_API_TOKEN'));

// For the Hypernode `johndoe` PHP version to 8.1 and Node.js version to 18
$job = $client->settings->setBatch('johndoe', [
    'php_version' => '8.1',
    'nodejs_version' => '18'
]);

// If something has changed, wait for the changes to be applied.
while ($job && !$job->completed()) {
    sleep(2);
    $job->refresh();
}

Here's a list of Hypernode API features implemented in the client.

• Updating one or multiple Hypernode settings at once.
• Querying/polling the logbook for the status of a job.
• Creating and cancelling Brancher Hypernode instances.