Skip to main content
POST
Create a volume

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Makes the request retry-safe. Sail remembers the answer it sent under a key, including a 400 or a 409, and replays it with Idempotent-Replayed: true for a retry that repeats the key, the method, the path, and the body. Bodies are compared byte for byte. Reusing a key for a different request returns 409, so send a corrected request under a new key. A key that is blank or only spaces is ignored, and the request runs without idempotency.

Any string of up to 255 bytes works, and characters outside ASCII count for more than one. A UUID is a good default. Keys are remembered for at least 24 hours and scoped to the API key that sent them.

A server error, or a failure to record the answer, can leave a key unsettled, and creating a Sailbox is where that matters. See Retrying safely.

Maximum string length: 255

Body

application/json
name
string
required

Name for the volume. Letters, numbers, ., -, and _ only. Names are unique within your organization.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._-]+$

Response

The volume.

volume_id
string
required

Id to pass when mounting the volume.

name
string
required

Name of the volume.

backend
string
required

Storage type of the volume.

status
string
required

Current state of the volume: ready once it can be mounted, and deleted once it has been removed.

created_at
string<date-time>

When the volume was created.

updated_at
string<date-time>

When the volume last changed.