Skip to main content
POST
Attach a data volume to an instance
Requires the IAM action compute:AttachVolume. See COMPUTE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Headers

Idempotency-Key
string

Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.

Maximum string length: 255

Path Parameters

instance_id
string<uuid>
required

Instance ID

Body

application/json
volume
string
required

Account-scoped volume reference (UUID, CRN or exact name).

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

device
string

Optional device-name override; auto-picks the next free slot (vdb/vdc/…) when omitted.

Example:

"vdb"

mount_path
string

When set, the in-guest agent formats the disk (only if blank) and mounts it at this path. Empty attaches the block device only.

Example:

"/data"

fstype
enum<string>
default:ext4

Filesystem the in-guest agent formats the disk with, and only when mount_path is set and the disk is blank. Rejected with 400 if it is neither value.

Available options:
ext4,
xfs

Response

Attachment accepted

volume
object
required