Accounts

Your Bytemark account contains multiple groups and each of those contains several virtual machines (also called Cloud Servers). To access an account, you need to authenticate with a username.

Endpoints

These URLs are relative to https://uk0.bigv.io

GET /accounts
GET /accounts?view=overview
GET /accounts?view=overview&include_deleted=true
GET /accounts/{account-id}

Setting a view parameter to overview will turn on nested information. This embeds other related information (such as the servers and groups in the account and their discs/NICs) into the response to save making HTTP calls. Note though that not all fields are necessarily included in overview mode. When view is set to overview and include_deleted is true, nested information for deleted servers will be included too.


Attributes

  • id – Unique key (integer).
  • name – Account name (string).
  • suspended – Flag to indicate the account has been suspended (boolean – true/false).

Examples

Account overview

Request
GET https://uk0.bigv.io/accounts?view=overview HTTP/1.1
Accept: application/json
Authorization: Bearer {session-id}
Curl
curl -H "Content-type: application/json" \
     -H "Authorization: Bearer {session-id}" \
     https://uk0.bigv.io/accounts/myaccountname?view=overview
Response (success: 200)
{
  "id": 1,
  "name": "myaccountname",
  "suspended": false,
  "groups": [
    {
      "id": 123,
      "name": "default",
      "virtual_machines": [...],
      ...
    }
  ]
}
Bytemark Cloud used to be called "BigV"—nothing has changed except the name! We’re hiring! Please visit careers.bytemark.co.uk to find out more.