Create volume from archive

Changed on

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

Request

  • Base URL
    http://localhost:4973
  • URL
    http://localhost:4973/volumes/from-archive
  • Auth
    HTTP bearer

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)

tagsTags

User-defined key-value tags.

Tags for the created volume.

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

Request body application/gzip

string binary required

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"
}

Changes

    • warning

      deleted the query request parameter metadata

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter tags

    • info

      added the optional property to the response with the status

    • info

      added the new optional query request parameter metadata

    • info

      added the optional property to the response with the status