curl --request GET \
--url https://api.aireserve.com/v1/gpu/pods/{podId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aireserve.com/v1/gpu/pods/{podId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aireserve.com/v1/gpu/pods/{podId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "requested",
"desiredState": "running",
"gpuTypeId": "<string>",
"gpuType": "<string>",
"gpuCount": 0,
"dataCenterId": "<string>",
"datacenter": "<string>",
"containerDiskGb": 0,
"volumeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"networkVolumeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"volumeMountPath": "<string>",
"imageName": "<string>",
"imageId": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCredentialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sshKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"ports": [
{
"port": 32768,
"protocol": "http"
}
],
"rateUsdPerHour": "<string>",
"runningHourlyRateUsd": "<string>",
"envKeys": [
"<string>"
],
"paidThroughAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"lastError": "<string>",
"terminatedAt": "2023-11-07T05:31:56Z",
"computeType": "GPU",
"cpuTypeId": "<string>",
"vcpuCount": 0,
"cloud": "SECURE",
"runpodTemplateId": "<string>"
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}Get pod
Current state of a pod. 404 for unknown IDs and for pods owned by other organizations. Requires compute read access.
curl --request GET \
--url https://api.aireserve.com/v1/gpu/pods/{podId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.aireserve.com/v1/gpu/pods/{podId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.aireserve.com/v1/gpu/pods/{podId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "requested",
"desiredState": "running",
"gpuTypeId": "<string>",
"gpuType": "<string>",
"gpuCount": 0,
"dataCenterId": "<string>",
"datacenter": "<string>",
"containerDiskGb": 0,
"volumeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"networkVolumeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"volumeMountPath": "<string>",
"imageName": "<string>",
"imageId": "<string>",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"registryCredentialId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sshKeyIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"ports": [
{
"port": 32768,
"protocol": "http"
}
],
"rateUsdPerHour": "<string>",
"runningHourlyRateUsd": "<string>",
"envKeys": [
"<string>"
],
"paidThroughAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"lastError": "<string>",
"terminatedAt": "2023-11-07T05:31:56Z",
"computeType": "GPU",
"cpuTypeId": "<string>",
"vcpuCount": 0,
"cloud": "SECURE",
"runpodTemplateId": "<string>"
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}{
"error": {
"message": "<string>",
"type": "invalid_request_error",
"param": "<string>",
"code": "<string>",
"details": {}
}
}Authorizations
Your AI Reserve API key (aireserve_api_…) from the API Keys page in the portal (https://portal.aireserve.com/keys).
Path Parameters
Response
OK
A GPU pod. Every non-secret attribute settable on create is echoed here so declarative clients can diff against live state.
^([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)$Observed state reported by the reconciler.
requested, provisioning, starting, running, stopping, stopped, terminating, terminated, reconciling, failed Control-plane target state. The pod converges asynchronously.
running, stopped, terminated Alias for gpuTypeId.
-9007199254740991 <= x <= 9007199254740991Alias for dataCenterId.
Ephemeral container disk in GiB. Destroyed on stop or terminate.
-9007199254740991 <= x <= 9007199254740991Alias for networkVolumeId.
^([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)$^([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)$Mount path of the attached network volume. Null when no volume is attached.
Alias for imageName.
^([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)$^([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)$^([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)$Exposed ports as launched (template ports merged in).
Show child attributes
Show child attributes
Locked hourly rate (GPU + container disk) accepted at creation.
^\d+(?:\.\d{1,6})?$Alias for rateUsdPerHour.
^\d+(?:\.\d{1,6})?$Names of injected environment variables. Values are never returned.
End of the current prepaid coverage window. Null when stopped or not yet running.
^(?:(?:\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)))$^(?:(?:\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)))$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.
^(?:(?:\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)))$GPU, CPU -9007199254740991 <= x <= 9007199254740991SECURE, COMMUNITY