Skip to main content
POST
Assign a bandwidth block to a location pool

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.

Path Parameters

bandwidthBlock
string
required

The bandwidth block UUID

Example:

"23653478-238e-4db3-b263-91a221b5e7c2"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

location_id
integer
required

The location id ID.

Response

The record, as a JSON object. There is no envelope.

A purchased or granted bandwidth allowance.

uuid
string
required

The uuid UUID.

Example:

"23653478-238e-4db3-b263-91a221b5e7c2"

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"

size
integer
required

The value of size.

Example:

2199023255552

consumed
integer
required

The value of consumed.

Example:

549755813888

remaining
integer
required

The value of remaining.

Example:

1649267441664

terabytes
integer
required

The value of terabytes.

Example:

2

status
enum<string>
required

The value of status.

Available options:
pending_payment,
active,
expired,
cancelled,
payment_review,
revoked
Example:

"active"

status_label
string
required

The value of status_label.

Example:

"Active"

progress_message
string | null
required

One sentence about why a purchase is waiting, most often how much the account is short by. Null once there is nothing to say.

Example:

null

needs_funds
boolean
required

Whether the purchase is waiting for enough account credit.

Example:

false

assignment
string
required

Whether the block is assigned to individual servers or a city.

Example:

"servers"

servers
BandwidthBlockServerData · object[]
required

The value of servers.

Example:
servers_in_other_teams
integer
required

The rest of what it covers, counted rather than named. Nought for the account holder, who is shown every one of them, and for anyone else not standing inside a single team.

Example:

0

attachable_servers
integer | null
required

How many of the account's servers this block could still be put behind: metered, in the region it was bought for, and not already covered by it. Null where it was not counted, which is not the same as none.

Example:

1

location
BandwidthBlockLocationData · object | null
required

The value of location.

Example:

null

unit_price
string
required

The value of unit_price.

Example:

"1.00"

billing
BillingData · object
required

The value of billing.

Example:
can_cancel
boolean
required

Whether the customer can cancel.

Example:

true

created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-08-20T11:26:14+00:00"

cancellation_refund
string
required

The value of cancellation_refund.

Example:

"1.50"

refund_amount
string | null
required

The value of refund_amount.

Example:

null

refund_pending
boolean
required

The value of refund_pending.

Example:

false

notice
string

Explains the coverage changed by this request.

Example:

"This block came off its server so it could feed the Kansas City, MO pool instead. A block covers named servers or a city, never both."