Create Volume

POST /v1/volumes/create

Authorization

circle-info

Provide your API key in the x-api-key request header.

Header:

  • x-api-key (string) — required

Request

Content-Type: application/json

Body parameters

  • name (string) — Volume name

  • size (string) — Volume size (e.g., 10Gi, 100Mi) Default: 10Gi

Example (curl)

create-volume.json
curl -X POST "https://api.example.com/v1/volumes/create" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "my-volume",
    "size": "10Gi"
  }'

Response

201 — application/json

Response fields:

  • id (string) — Volume ID (required)

  • name (string) — Volume name (required)

  • created_at (string) — Creation timestamp (required)

  • size (string) — Volume size (required)

  • status (string) — Volume status (Pending/Bound/Lost) (required)

Example response

Last updated