Skip to main content
POST
/
volumes
Create volume
curl --request POST \
  --url https://api.blaxel.ai/v0/volumes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "events": [
    {
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<any>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "region": "<string>",
    "size": 123,
    "template": "<string>"
  },
  "state": {
    "attachedTo": "<string>"
  },
  "status": "<string>",
  "terminatedAt": "<string>"
}'
{
  "events": [
    {
      "message": "<string>",
      "revision": "<string>",
      "status": "<string>",
      "time": "<string>",
      "type": "<string>"
    }
  ],
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<any>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "region": "<string>",
    "size": 123,
    "template": "<string>"
  },
  "state": {
    "attachedTo": "<string>"
  },
  "status": "<string>",
  "terminatedAt": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Volume resource for persistent storage

​
events
object[]

Events are loaded from the events table, not stored in volume table

​
metadata
object

Metadata Time fields for Persistance Owner fields for Persistance

​
spec
object

Volume specification - immutable configuration

​
state
object

Volume state - mutable runtime state

​
status
string

Volume status computed from events

​
terminatedAt
string

Timestamp when the volume was marked for termination

Response

200 - application/json

successful operation

Volume resource for persistent storage

​
events
object[]

Events are loaded from the events table, not stored in volume table

​
metadata
object

Metadata Time fields for Persistance Owner fields for Persistance

​
spec
object

Volume specification - immutable configuration

​
state
object

Volume state - mutable runtime state

​
status
string

Volume status computed from events

​
terminatedAt
string

Timestamp when the volume was marked for termination

⌘I