Skip to main content
GET
/
drives
/
{driveName}
Get a drive
curl --request GET \
  --url https://api.blaxel.ai/v0/drives/{driveName} \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {
    "name": "my-resource",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Resource",
    "labels": {},
    "plan": "<string>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "infrastructureId": "<string>",
    "region": "us-pdx-1",
    "size": 100
  },
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "state": {},
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

​
driveName
string
required

Response

successful operation

Drive providing persistent storage that can be attached to agents, functions, and sandboxes. Drives are backed by SeaweedFS buckets and can be mounted at runtime via the sbx API.

​
metadata
object
required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

​
spec
object
required

Immutable drive configuration set at creation time

​
events
object[]

Events happening on a resource deployed on Blaxel

​
state
object

Current runtime state of the drive

​
status
string

Drive status computed from events