v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB

volumes

Get volume by external ID

Returns an active volume matching the given external ID. If no active volume is found, returns 404.

get/volumes/by-external-id/{externalId}

Response

successful operation

statusstring

Volume status computed from events

terminatedAtstring

Timestamp when the volume was marked for termination

Example response

{
  "events": [
    {
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "metadata": {
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "name": "my-resource"
  },
  "spec": {
    "region": "us-pdx-1",
    "size": 1024,
    "template": "mytemplate:latest"
  },
  "state": {
    "attachedTo": "sandbox:my-sandbox"
  }
}