Resources¶

When you use apis like server(), node(), it will return a resource instance.

Then you can call the functions of the instance, like $server->update(), $node->delete(), etc.

Note

Be noticed that when you use functions like update(), the changes won't applied to the instance itself, so you should manually call the get api again to get the latest data.

Here's a list of available resource types.

Type¶

Allocation¶

The allocation resource.

Egg¶

The egg resource.

Location¶

The location resource.

Functions¶

<?php
  $location->delete();
  $location->update(array $data);
?>

Nest¶

The nest resource.

Functions¶

<?php
  $nest->eggs();
  $nest->egg($eggId, $includes = []);
?>

Node¶

The node resource.

Functions¶

<?php
  $node->delete();
  $node->update(array $data);
  $node->allocations(int $page = 1);
  $node->createAllocation(array $data);
  $node->deleteAllocation($allocationId);
?>

Server¶

The server resource.

Functions¶

<?php
  //Available with Application API
  $server->delete();
  $server->forceDelete();
  $server->suspend();
  $server->unsuspend();
  $server->updateDetails(array $data);
  $server->updateBuild(array $data);
  $server->updateStartup(array $data);
  $server->reinstall();
  $server->rebuild();

  $server->databases();
  $server->database($databaseId);
  $server->resetDatabasePassword($databaseId);
  $server->deleteDatabase($databaseId);

  //Available with Account API
  $server->power($action);
  $server->command($command);
?>

ServerDatabase¶

The server database resource.

Functions¶

<?php
  $serverdatabase->resetPassword();
  $serverdatabase->delete();
?>

Stats¶

The stats resource.

User¶

The user resource.

Functions¶

<?php
  $user->delete();
  $user->update(array $data);
?>