Skip to main content
GET
Get pod

Authorizations

Authorization
string
header
required

Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys).

Path Parameters

podId
string<uuid>
required

Response

OK

A GPU pod. Every non-secret attribute settable on create is echoed here so declarative clients can diff against live state.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
status
enum<string>
required

Observed state reported by the reconciler.

Available options:
requested,
provisioning,
starting,
running,
stopping,
stopped,
terminating,
terminated,
reconciling,
failed
desiredState
enum<string>
required

Control-plane target state. The pod converges asynchronously.

Available options:
running,
stopped,
terminated
gpuTypeId
string | null
required
gpuType
string | null
required

Alias for gpuTypeId.

gpuCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
dataCenterId
string
required
datacenter
string
required

Alias for dataCenterId.

containerDiskGb
integer
required

Ephemeral container disk in GiB. Destroyed on stop or terminate.

Required range: -9007199254740991 <= x <= 9007199254740991
volumeId
string<uuid> | null
required

Alias for networkVolumeId.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
networkVolumeId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
volumeMountPath
string | null
required

Mount path of the attached network volume. Null when no volume is attached.

imageName
string
required
imageId
string
required

Alias for imageName.

templateId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
registryCredentialId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
sshKeyIds
string<uuid>[]
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ports
object[]
required

Exposed ports as launched (template ports merged in).

rateUsdPerHour
string
required

Locked hourly rate (GPU + container disk) accepted at creation.

Pattern: ^\d+(?:\.\d{1,6})?$
runningHourlyRateUsd
string
required

Alias for rateUsdPerHour.

Pattern: ^\d+(?:\.\d{1,6})?$
envKeys
string[]
required

Names of injected environment variables. Values are never returned.

paidThroughAt
string<date-time> | null
required

End of the current prepaid coverage window. Null when stopped or not yet running.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
lastError
string | null
required
terminatedAt
string<date-time> | null
required

Set once the pod is final: terminated, or a create that failed before anything was provisioned. A final pod bills nothing and accepts no lifecycle action; status tells you which ending it was.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
computeType
enum<string>
Available options:
GPU,
CPU
cpuTypeId
string | null
vcpuCount
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991
cloud
enum<string>
Available options:
SECURE,
COMMUNITY
runpodTemplateId
string | null