Skip to main content
POST
Create a Volume

Body

application/json

Request model for creating a PersistentVolume and PersistentVolumeClaim.

name
string
required

Name of the volume (max 63 chars, DNS-1035 format: lowercase alphanumeric and hyphens, must start with letter)

size
string
required

Storage size (e.g., '1Gi', '10Gi')

Examples:

"1Gi"

"5Gi"

"10Gi"

storage_class
string | null

Storage class name. Only 'standard' is allowed. Uses cluster default if not specified.

Allowed value: "standard"
wait_for_ready
boolean
default:true

Wait for volume to be bound before returning. If True, the request blocks until the PVC is bound or times out.

timeout
integer
default:60

Timeout in seconds when wait_for_ready is True.

Required range: 5 <= x <= 300

Response

Successful Response

Response model for a Volume.

name
string
required
size
string
required
storage_class
string
required
id
string<uuid> | null

Unique volume identifier

created_at
string | null
updated_at
string | null