API Clients

An API Client is a set of credentials for accessing the Brightbox Cloud API. It’s composed of a client identifier (like cli-xxxxx) and a randomly generated secret.

API Clients are associated with Accounts, so once authenticated with a given API Client you can manage all the services on that Account.

An API Client id and secret are used to obtain a token, which is then use for authentication. Tokens are valid for 2 hours and are not revoked when an API Client is deleted.

You can create and manage API Clients using the Brightbox Manager, and of course via the API itself.

API Clients are not affected by two-factor authentication.


There are two types of API client privileges, Full and Orbit Storage Only.


An API Client with Full privileges can access and manage all resources on the account, including managing other API clients and full read-write access to all Orbit storage containers.

Orbit Storage Only

An API Client with Orbit Storage Only privileges can only be used with the Orbit Storage System API. Orbit API Clients cannot be used to manage or access any other resources (such as Cloud Servers, Load Balancers etc.).

Orbit API Clients must be given specific read or write access to individual Orbit containers, and are limited to accessing only objects. They cannot be used to create or modify containers, which instead must be done using an API Client with Full privileges.

Last updated: 17 Sep 2018 at 11:37 UTC

Try Brightbox risk-free with £20 free credit Sign up takes just two minutes...