Sign in

v3

latestOpenAPI 3.0.0Apache-2.02026-07-27184128410.6 KB
volumes

Get volume details by name

get/volumes/by-name/{name}

Path parameters

namestring required

Name of the volume

Headers

X-Daytona-Organization-IDstring

Use with JWT to specify the organization ID

Response

Volume details

idstring required

Volume ID

namestring required

Volume name

organizationIdstring required

Organization ID

state'creating' | 'ready' | 'pending_create' | 'pending_delete' | 'deleting' | 'deleted' | 'error' required

Volume state

createdAtstring required

Creation timestamp

updatedAtstring required

Last update timestamp

lastUsedAtstring nullable

Last used timestamp

errorReasonstring nullable required

The error reason of the volume

Example response

{
  "id": "vol-12345678",
  "name": "my-volume",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "lastUsedAt": "2023-01-01T00:00:00.000Z",
  "errorReason": "Error processing volume"
}