Skip to main content
GET
List bandwidth usage by location

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Response

The whole set, as a JSON array. There is no envelope and no paging.

location_id
integer
required

The location id ID.

Example:

3

name
string
required

The name shown to customers.

Example:

"Kansas City, MO"

region
enum<string>
required

The value of region.

Available options:
us_eu,
apac
Example:

"us_eu"

region_label
string
required

The value of region_label.

Example:

"Americas & EMEA"

pooling
boolean
required

Whether the team's servers here share one budget or are metered one by one.

Example:

false

servers
integer
required

The value of servers.

Example:

2

shaped_servers
integer
required

The value of shaped_servers.

Example:

0

base_limit
integer
required

What the plans alone allow here, in bytes.

Example:

10995116277760

usage
integer
required

The value of usage.

Example:

1358993459200

capacity
integer
required

The budget in force, plans and blocks together.

Example:

12644383719424

covered
integer
required

How much of that budget the team's blocks are responsible for.

Example:

1649267441664

remaining
integer
required

The value of remaining.

Example:

11285390260224

blocks
integer
required

The value of blocks.

Example:

1

block_bytes_available
integer
required

The value of block_bytes_available.

Example:

1649267441664

exhausted
boolean
required

With pooling on, the whole city at once. With it off, whether at least one server here has been shaped.

Example:

false

Example: