v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-175267122.5 KB

Create volume from archive

Creates a new volume pre-populated with content from a tar.gz archive. The archive is streamed directly into the volume's root directory.

post/volumes/from-archive

Query parameters

namestring required

Volume name

size_gbinteger required

Maximum size in GB (extraction fails if content exceeds this)

idstring

Optional custom volume ID (auto-generated if not provided)

tagsobject

User-defined key-value tags.

Tags for the created volume.

{
  "team": "backend",
  "env": "staging"
}

Response

Volume created

idstring required

Unique identifier

namestring required

Volume name

size_gbinteger required

Size in gigabytes

tagsTags

User-defined key-value tags.

created_atstring date-time required

Creation timestamp (RFC3339)

Example response

{
  "id": "vol-data-1",
  "name": "my-data-volume",
  "size_gb": 10,
  "tags": {
    "team": "backend",
    "env": "staging"
  },
  "attachments": [
    {
      "instance_id": "inst-abc123",
      "mount_path": "/mnt/data"
    }
  ],
  "created_at": "2025-01-15T09:00:00Z"
}