Skip to main content
POST
Resize a snapshot storage

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

snapshotStorage
string
required

The snapshot storage UUID

Example:

"9e83397b-d88e-43ae-bfb7-a8c2e6eda853"

Body

application/json

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

size_gb
integer
required

The value of size_gb.

Required range: 100 <= x <= 10000

Response

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

A snapshot storage: what it is, how full it is, what it costs, and what may be done with it right now.

uuid
string
required

The uuid UUID.

Example:

"9e83397b-d88e-43ae-bfb7-a8c2e6eda853"

name
string
required

The name shown to customers.

Example:

"Storage 1"

status
enum<string>
required

The value of status.

Available options:
pending_payment,
active,
pending_cancellation,
terminating,
terminated,
expired,
payment_review
Example:

"active"

status_label
string
required

The status in the customer's words, with suspension first.

Example:

"Active"

progress_message
string | null
required

What the purchase is waiting on, when it is waiting on something.

Example:

null

needs_funds
boolean
required

Whether the purchase is waiting for the account to hold enough credit.

Example:

false

size_gb
integer
required

The size bought, in whole GiB.

Example:

200

capacity
integer
required

The size bought, in bytes.

Example:

214748364800

used
integer
required

What the finished snapshots in it occupy, in bytes.

Example:

85899345920

remaining
integer
required

Capacity less used, never below nought, in bytes.

Example:

128849018880

snapshots_count
integer
required

The number of snapshots count.

Example:

1

is_suspended
boolean
required

Whether billing has suspended it. Its snapshots are frozen while it is.

Example:

false

is_usable
boolean
required

Whether snapshots may be taken into, restored from, deleted from or moved in or out of it.

Example:

true

billing
BillingData · object
required

The value of billing.

Example:
cancellation_type
enum<string> | null
required

The value of cancellation_type.

Available options:
immediate,
end_of_billing,
null
Example:

null

cancellation_requested_at
string | null
required

The date and time for cancellation requested at, in UTC.

Example:

null

autopay
boolean
required

The value of autopay.

Example:

false

can_cancel
boolean
required

Whether the customer can cancel.

Example:

false

can_resize
boolean
required

Whether the customer can resize.

Example:

true

pending_resize
SnapshotStorageResizeData · object | null
required

A change of size still being paid for or written to billing.

Example:

null

created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-06-03T17:26:40+00:00"