Pods

Create Pod

post

Create a new pod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Pod Create Request v2

regionsstring[]Optional

Acceptable region codes

namestring · min: 1 · max: 255Required

Pod name

imagestring · min: 1 · max: 255Required

Docker image name

Example: pytorch/pytorch:2.0.0-cuda11.7-cudnn8-runtime
containerRegistryAuthIdinteger · int64Optional

Container registry auth ID

imageRegistrystring · max: 255Optional

Image registry URL

imagePublicTypestringOptional

Image type: PUBLIC or PRIVATE

Example: PUBLIC
resourceTypestringOptional

Resource type: GPU or CPU

Example: GPU
gpuTypestring · min: 1Required

GPU type

Example: RTX_4090_24G
gpuCountinteger · int32Required

GPU count (must be power of 2)

Example: 1
shmInGbinteger · int32Optional

Shared memory size in GB

minSingleCardRamInGbinteger · int32Optional

Minimum single card RAM in GB

minSingleCardVramInGbinteger · int32Optional

Minimum single card VRAM in GB

minSingleCardVcpuinteger · int32Optional

Minimum single card vCPU count

containerVolumeInGbinteger · int32Optional

Container volume size in GB

persistentVolumeInGbinteger · int32Optional

Persistent volume size in GB

initializationCommandstringOptional

Initialization command

Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

post
/v2/pods

Resume Pod

post

Resume a paused pod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

post
/v2/pods/{id}/resume

Delete Pod

delete

Delete a pod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

delete
/v2/pods/{id}

Pause Pod

post

Pause a running pod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

post
/v2/pods/{id}/pause

Get Pod

get

Get details of a specific pod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idinteger · int64Required
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

get
/v2/pods/{id}

List Pods

get

Get all pods for your organization

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
regionListstring[]Optional
statusListinteger · int32[]Optional
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

dataanyOptional

data

get
/v2/pods

Get pod detail

get

Fetch detailed information of a specific pod by its ID

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
podIdinteger · int64Required
Responses
chevron-right
200

OK

*/*
messagestringOptional

message

codeinteger · int32Optional

code

get
/openapi/v1/pods/{podId}

Last updated

Was this helpful?