Runpod

App · 25 actions

Manage GPU Pods, Serverless endpoints, templates and network volumes with Runpod API v2, and submit, inspect, stream or cancel Serverless jobs.

Actions

ActionWhat it does
Cancel Serverless jobCancel Serverless job.
Create a network volumeCreate a network volume.
Create a podCreate a pod.
Create a serverless endpointCreate a serverless endpoint.
Create a templateCreate a template.
Delete a network volumeDelete a network volume.
Delete a serverless endpointDelete a serverless endpoint.
Delete a templateDelete a template.
Get a network volumeGet a network volume.
Get a podGet a pod.
Get a serverless endpointGet a serverless endpoint.
Get a templateGet a template.
Get endpoint healthGet endpoint health.
Get Serverless jobGet Serverless job.
Get streamed job resultsGet streamed job results.
List network volumesList network volumes.
List podsList pods.
List serverless endpoint workersList serverless endpoint workers.
List serverless endpointsList serverless endpoints.
List templatesList templates.
Run Serverless jobRun Serverless job.
Run Serverless job and waitSubmit a Serverless job and wait briefly for a result.
Terminate a podTerminate a pod.
Trigger a pod state transitionTrigger a pod state transition.
Update a templateUpdate a template.

Cancel Serverless job

Cancel Serverless job.

Inputs

Endpointendpoint_idtextRequired
Endpoint id
Job IDjob_idtextRequired
The job ID returned when the job was submitted.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
The token for the next page, or empty when complete.
Example output
{
  "data": {
    "id": "example",
    "output": {},
    "status": "example",
    "stream": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Create a network volume

Create a network volume.

Inputs

DataCenterdataCentertextRequired
Data center in which to create the volume
NamenametextRequired
Human-readable name
SizesizenumberRequired
Storage to allocate in GBFrom 10 to 4096.
Typetypetext
Data center network volume storage type.One of: STANDARD, HIGH_PERFORMANCE.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "dataCenter": "example",
    "id": "example",
    "name": "example",
    "size": 10,
    "type": "STANDARD"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create a pod

Create a pod.

Inputs

Container argumentscontainer_argstext
The container's command, as a single raw string. This is the field `entrypoint` and `cmd` encode into, exposed in its stored form. Two shapes are accepted. A bare shell string is treated as CMD and split into arguments, which is what the console's "Container start command" field writes. A JSON object of the form `{"entrypoint":[...],"cmd":[...]}` sets either or both explicitly. Responses always return both representations: `args` exactly as stored, plus the deconstructed `entrypoint` and `cmd`. Supplying `args` together with `entrypoint` or `cmd` is allowed only when they describe the same command, so a read-modify-write client can send back everything it received. Send `""` to clear, omit to leave unchanged.
Cmdcmdlist
Container CMD in exec form. When the image defines an ENTRYPOINT, this is the argument list passed to it. Encoded into the `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Entrypointentrypointlist
Container ENTRYPOINT in exec form, overriding the image's own. Encoded into `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Diskdisknumber
Container disk in GB (ephemeral, wiped on restart)At least 1.
Envenvobject
Environment variables as key-value pairs
Imageimagetext
Docker image reference
Portsportslist
Exposed ports, formatted as port/protocol
Registryregistrytext
Container registry credential ID (for private images)
NamenametextRequired
Name
Cloudcloudtext
Cloud tier. - `SECURE` : Runpod-owned datacenter hardware - `COMMUNITY` : community-hosted hardwareOne of: SECURE, COMMUNITY.
CPU typecpu_idtext
CPU flavor identifier, as returned by GET /v2/catalog/cpus.
CPU vcpuCountcpu_vcpuCountnumber
Number of vCPUs. Must be valid for the selected CPU flavor and must be a power of two.At least 2.
DataCenterIdsdataCenterIdslist
Preferred data centers for placement. Omit or pass an empty array to let the scheduler choose.
GlobalNetworkingglobalNetworkingtrue/false
Enable global networking, giving the pod a private IP reachable across data centers. Requires an NVIDIA GPU and a global-networking-enabled data center (both enforced upstream). See `GET /v2/catalog/datacenters` (`globalNetwork`) for eligible data centers.
GPU typegpu_idtext
GPU type identifier
GPU countgpu_countnumber
Number of GPUsAt least 1.
GPU allowedCudaVersionsgpu_allowedCudaVersionslist
Acceptable CUDA versions for the host machine, as `major.minor`. Omit to accept any version. Matching is exact, so a version no machine reports yields a capacity error rather than a fallback : discover valid values per GPU type via `GET /v2/catalog/gpus?include=AVAILABILITY&product=POD` (`cudaVersions`). A non-empty set is mutually exclusive with minCudaVersion (400 if both are sent). An explicit `[]` states no constraint, so it may accompany a floor.
GPU minCudaVersiongpu_minCudaVersiontext
Lowest acceptable CUDA version for the host machine, as `major.minor`, compared numerically rather than as a decimal : so 12.11 is above 12.2. Use this for an open-ended floor and allowedCudaVersions for an exact set. Mutually exclusive with a non-empty allowedCudaVersions (400 if both are sent); an explicit `[]` there states no constraint and may accompany this floor.
GPU minRamPerGpugpu_minRamPerGpunumber
Minimum host system RAM in GB per requested GPU. This is a placement filter, not a resource request. The actual total allocated system RAM may be higher and is returned in gpu.memory.At least 1.
GPU minVcpuCountPerGpugpu_minVcpuCountPerGpunumber
Minimum host vCPU count per requested GPU. This is a placement filter, not a resource request. The actual total allocated vCPU count may be higher and is returned in gpu.vcpuCount.At least 1.
Mountsmountsobject
Storage mounts attached to a pod. `persistent` is mutually exclusive with both `network` and `global` (enforced at the handler with 400 if combined). The `network` field is an array for forward compatibility with eventual multi-network-volume support, but `maxItems` is 1 today. PATCH semantics: - Omitting `mounts` or sending `{}` leaves the existing mount unchanged. - An explicit `network: []` is rejected with 400 (clearing mounts is not supported). - Mount kind is fixed at create : a PATCH that introduces a kind not present at create (persistent on a network pod, network on a persistent pod, or any mount on a previously-mountless pod) is rejected with 400. - The `volumeId` of a network mount is immutable; a PATCH that names a different `volumeId` is rejected with 400. - Partial mounts are not supported : every mount entry must include the full schema (`size` + `path` for persistent, `volumeId` + `path` for network). Missing required fields → 422.
StartJupyterstartJupytertrue/false
Create-time flag telling the provisioner to start JupyterLab: injects a generated `JUPYTER_PASSWORD` environment variable, unless the request already sets one. Only images that honor the convention start Jupyter from it (Runpod official images do); expose `8888/http` in `ports` to reach it. Not part of the pod's readable config : never returned by GET and not changeable by PATCH.
StartSshstartSshtrue/false
Create-time flag telling the provisioner to set up SSH access: injects a `PUBLIC_KEY` environment variable carrying your account's registered SSH public keys, unless the request already sets one. **Requires registered keys** (`PUT /v2/account/ssh-keys`) : with none registered the flag does nothing and the pod has no SSH access. Only images that honor the convention start sshd from it (all Runpod official images do). Connect using the pod's `ssh` block; the `ssh.direct` variant additionally needs a `22/tcp` entry in `ports`. Not part of the pod's readable config : never returned by GET and not changeable by PATCH.
TemplateIdtemplateIdtext
ID of a pod template to base this pod on. The template is resolved at create time into the same container settings you could otherwise spread into this body (image, args, disk, ports, env, registry, persistent mount, startSsh, startJupyter, allowedCudaVersions); explicit body fields override the template's, except `env`, which is merged per key with body values winning. Sending either CUDA field (`gpu.allowedCudaVersions` or `gpu.minCudaVersion`) replaces the template's CUDA constraint entirely, and CPU pods ignore it (like the persistent mount). The template is a one-time source of settings: later template edits do not affect the pod, and the created pod does not retain a link to the template (`template` stays null). The template may be one of your own or a public catalog template : see `GET /v2/catalog/templates` (unknown or inaccessible ID → 404) : and must not be a serverless template (→ 422). CPU pods do not inherit a template's persistent mount.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "actions": [],
    "args": "example",
    "cloud": "SECURE",
    "cluster": {
      "id": "example",
      "ip": "example",
      "rank": null,
      "role": "SLURM_CONTROLLER"
    },
    "cmd": [],
    "cost": 0,
    "cpu": {
      "id": "example",
      "memory": 1,
      "vcpuCount": 2
    },
    "createdAt": "2026-01-01T00:00:00Z",
    "cudaVersion": null,
    "dataCenterId": null,
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "globalNetworking": {
      "enabled": false,
      "internalDns": "example",
      "ip": "example"
    },
    "gpu": {
      "count": 1,
      "id": "example",
      "memory": 1,
      "vcpuCount": 1
    },
    "id": "example",
    "image": "example",
    "locked": false,
    "mounts": {
      "global": [],
      "network": [],
      "persistent": {
        "path": "example",
        "size": 10
      }
    },
    "name": "example",
    "ports": [],
    "registry": null,
    "runtime": null,
    "ssh": {
      "direct": null,
      "proxy": null
    },
    "startedAt": null,
    "status": "PROVISIONING",
    "template": null
  },
  "has_more": false,
  "next_cursor": "example"
}

Create a serverless endpoint

Create a serverless endpoint.

Inputs

Container argumentscontainer_argstext
The container's command, as a single raw string. This is the field `entrypoint` and `cmd` encode into, exposed in its stored form. Two shapes are accepted. A bare shell string is treated as CMD and split into arguments, which is what the console's "Container start command" field writes. A JSON object of the form `{"entrypoint":[...],"cmd":[...]}` sets either or both explicitly. Responses always return both representations: `args` exactly as stored, plus the deconstructed `entrypoint` and `cmd`. Supplying `args` together with `entrypoint` or `cmd` is allowed only when they describe the same command, so a read-modify-write client can send back everything it received. Send `""` to clear, omit to leave unchanged.
Cmdcmdlist
Container CMD in exec form. When the image defines an ENTRYPOINT, this is the argument list passed to it. Encoded into the `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Entrypointentrypointlist
Container ENTRYPOINT in exec form, overriding the image's own. Encoded into `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Diskdisknumber
Container disk in GB (ephemeral, wiped on restart)At least 1.
Envenvobject
Environment variables as key-value pairs
Imageimagetext
Docker image reference
Portsportslist
Exposed ports, formatted as port/protocol
Registryregistrytext
Container registry credential ID (for private images)
Gpugpuobject
GPU request for an endpoint create. Carries the CUDA constraints, which live here rather than at the body's top level so they are unrepresentable on a CPU endpoint.
NamenametextRequired
Name
ScalingscalingobjectRequired
Scale on queue wait time. Queue-based endpoints only.
TypetypetextRequired
Request-routing semantics for a modern serverless endpoint. - `QUEUE` : submit asynchronous or synchronous jobs through the managed queue. - `LOAD_BALANCER` : send requests directly to worker-defined HTTP paths. Configure via `env`: `PORT` (server port, default 80), `PORT_HEALTH` (health-check port, default 80), and `HEALTH_CHECK_PATH` (path the load balancer polls for worker health, default `/ping`).One of: QUEUE, LOAD_BALANCER.
Cpucpulist
Eligible CPU configurations for each worker. Memory is derived from the selected flavor's catalog RAM multiplier. Exact duplicate configurations are rejected; the same flavor may be listed at different vCPU counts.
DataCenterIdsdataCenterIdslist
Preferred data centers for placement. Omit or pass an empty array to let the scheduler choose.
Flashbootflashboottext
FlashBoot cold-start acceleration mode. - `OFF` : disabled - `FLASHBOOT` : enabled - `PRIORITY_FLASHBOOT` : enabled with priority capacityOne of: OFF, FLASHBOOT, PRIORITY_FLASHBOOT.
NetworkVolumesnetworkVolumeslist
Network volume IDs.
Mountsmountsobject
Volumes to mount on the endpoint's workers. A `network` or `global` list that is present replaces the endpoint's current list of that kind; an empty list detaches it, and an omitted list is left unchanged. Both kinds cannot be present on the endpoint at once, so to switch kinds send `[]` for one and the new list for the other in the same request. Changes apply to workers created afterwards. At most one global volume, GPU endpoints only. `network` may accompany the deprecated `networkVolumes` field only if the two agree exactly.
TemplateIdtemplateIdtext
ID of a serverless template to base this endpoint on. The template is resolved at create time into the same container settings you could otherwise spread into this body (image, args, disk, ports, env, registry); explicit body fields override the template's, except `env`, which is merged per key with body values winning. The template's allowedCudaVersions seeds `gpu.allowedCudaVersions` when the body omits it : but only for a GPU create, since a CPU endpoint has no gpu block to seed into, and not when the body sets `gpu.minCudaVersion`, since seeding a set beside a floor would manufacture the mutual-exclusion 400 from a valid request. Its pod-specific startSsh/startJupyter flags are ignored. Later template edits do not affect the endpoint. The template may be one of your own or a public catalog template : see `GET /v2/catalog/templates` (unknown or inaccessible ID → 404) : and must be a serverless template (→ 422).
Timeouttimeoutnumber
Timeout
Workersworkersobject
Workers

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "args": "example",
    "cmd": [],
    "cpu": [],
    "createdAt": "2026-01-01T00:00:00Z",
    "dataCenterIds": [],
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "flashboot": "OFF",
    "gpu": null,
    "id": "example",
    "image": "example",
    "mounts": {
      "global": [],
      "network": []
    },
    "name": "example",
    "networkVolumes": [],
    "ports": [],
    "registry": null,
    "requestUrls": {
      "cancel": "example",
      "health": "example",
      "purgeQueue": "example",
      "retry": "example",
      "run": "example",
      "runSync": "example",
      "status": "example",
      "stream": "example"
    },
    "scaling": {
      "queueDelay": 0.5,
      "type": "QUEUE_DELAY"
    },
    "timeout": 0,
    "type": "QUEUE",
    "workers": {
      "idleTimeout": 1,
      "max": 0,
      "min": 0
    }
  },
  "has_more": false,
  "next_cursor": "example"
}

Create a template

Create a template.

Inputs

Container argumentscontainer_argstext
The container's command, as a single raw string. This is the field `entrypoint` and `cmd` encode into, exposed in its stored form. Two shapes are accepted. A bare shell string is treated as CMD and split into arguments, which is what the console's "Container start command" field writes. A JSON object of the form `{"entrypoint":[...],"cmd":[...]}` sets either or both explicitly. Responses always return both representations: `args` exactly as stored, plus the deconstructed `entrypoint` and `cmd`. Supplying `args` together with `entrypoint` or `cmd` is allowed only when they describe the same command, so a read-modify-write client can send back everything it received. Send `""` to clear, omit to leave unchanged.
Cmdcmdlist
Container CMD in exec form. When the image defines an ENTRYPOINT, this is the argument list passed to it. Encoded into the `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Entrypointentrypointlist
Container ENTRYPOINT in exec form, overriding the image's own. Encoded into `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Diskdisknumber
Container disk in GB (ephemeral, wiped on restart)At least 1.
Envenvobject
Environment variables as key-value pairs
ImageimagetextRequired
Docker image reference
Portsportslist
Exposed ports, formatted as port/protocol
Registryregistrytext
Container registry credential ID (for private images)
NamenametextRequired
Name
AllowedCudaVersionsallowedCudaVersionslist
Acceptable CUDA versions for containers created from this template, as `major.minor`. Omit to accept any version : see the same field on `createPod` for matching semantics. Expanded into GPU pod and serverless endpoint creates; CPU pods ignore it.
Categorycategorytext
Controls how the template is grouped and filtered in the Runpod console. It does not affect hardware selection, scheduling, or billing. - `CPU` : CPU-only workloads - `NVIDIA` : NVIDIA GPU workloads - `AMD` : AMD GPU workloadsOne of: CPU, NVIDIA, AMD.
Mountsmountsobject
Storage mounts attached to a template. Templates support only a single persistent mount today; any `network` property is rejected with 422 by the schema validator. PATCH semantics: omitting `mounts` or sending `{}` leaves the existing mount unchanged.
Publicpublictrue/false
Public
Serverlessserverlesstrue/false
Serverless
StartJupyterstartJupytertrue/false
Start JupyterLab in containers created from this template: injects a generated `JUPYTER_PASSWORD` environment variable, unless `env` already sets one. Only images that honor the convention start Jupyter from it (Runpod official images do); expose `8888/http` in `ports` to reach it. Defaults to `true` when omitted, matching console-created templates.
StartSshstartSshtrue/false
Provision SSH access in containers created from this template: injects a `PUBLIC_KEY` environment variable carrying the deployer's registered SSH public keys (`PUT /v2/account/ssh-keys` : with none registered the flag does nothing), unless `env` already sets one. Only images that honor the convention start sshd from it (all Runpod official images do); direct SSH also needs a `22/tcp` entry in `ports`. Defaults to `true` when omitted, matching console-created templates.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "allowedCudaVersions": [],
    "args": "example",
    "category": "CPU",
    "cmd": [],
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "id": "example",
    "image": "example",
    "mounts": {
      "persistent": {
        "path": "example",
        "size": 10
      }
    },
    "name": "example",
    "ports": [],
    "public": false,
    "registry": null,
    "serverless": false,
    "startJupyter": false,
    "startSsh": false
  },
  "has_more": false,
  "next_cursor": "example"
}

Delete a network volume

Delete a network volume.

Inputs

Network volumeidtextRequired
Network volume identifier

Outputs

datanull
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Delete a serverless endpoint

Delete a serverless endpoint.

Inputs

EndpointidtextRequired
Serverless endpoint identifier

Outputs

datanull
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Delete a template

Delete a template.

Inputs

TemplateidtextRequired
Id

Outputs

datanull
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Get a network volume

Get a network volume.

Inputs

Network volumeidtextRequired
Network volume identifier

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "dataCenter": "example",
    "id": "example",
    "name": "example",
    "size": 10,
    "type": "STANDARD"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get a pod

Get a pod.

Inputs

PodidtextRequired
Pod identifier

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "actions": [],
    "args": "example",
    "cloud": "SECURE",
    "cluster": {
      "id": "example",
      "ip": "example",
      "rank": null,
      "role": "SLURM_CONTROLLER"
    },
    "cmd": [],
    "cost": 0,
    "cpu": {
      "id": "example",
      "memory": 1,
      "vcpuCount": 2
    },
    "createdAt": "2026-01-01T00:00:00Z",
    "cudaVersion": null,
    "dataCenterId": null,
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "globalNetworking": {
      "enabled": false,
      "internalDns": "example",
      "ip": "example"
    },
    "gpu": {
      "count": 1,
      "id": "example",
      "memory": 1,
      "vcpuCount": 1
    },
    "id": "example",
    "image": "example",
    "locked": false,
    "mounts": {
      "global": [],
      "network": [],
      "persistent": {
        "path": "example",
        "size": 10
      }
    },
    "name": "example",
    "ports": [],
    "registry": null,
    "runtime": null,
    "ssh": {
      "direct": null,
      "proxy": null
    },
    "startedAt": null,
    "status": "PROVISIONING",
    "template": null
  },
  "has_more": false,
  "next_cursor": "example"
}

Get a serverless endpoint

Get a serverless endpoint.

Inputs

EndpointidtextRequired
Serverless endpoint identifier

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "args": "example",
    "cmd": [],
    "cpu": [],
    "createdAt": "2026-01-01T00:00:00Z",
    "dataCenterIds": [],
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "flashboot": "OFF",
    "gpu": null,
    "id": "example",
    "image": "example",
    "mounts": {
      "global": [],
      "network": []
    },
    "name": "example",
    "networkVolumes": [],
    "ports": [],
    "registry": null,
    "requestUrls": {
      "cancel": "example",
      "health": "example",
      "purgeQueue": "example",
      "retry": "example",
      "run": "example",
      "runSync": "example",
      "status": "example",
      "stream": "example"
    },
    "scaling": {
      "queueDelay": 0.5,
      "type": "QUEUE_DELAY"
    },
    "timeout": 0,
    "type": "QUEUE",
    "workers": {
      "idleTimeout": 1,
      "max": 0,
      "min": 0
    }
  },
  "has_more": false,
  "next_cursor": "example"
}

Get a template

Get a template.

Inputs

TemplateidtextRequired
Id

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "allowedCudaVersions": [],
    "args": "example",
    "category": "CPU",
    "cmd": [],
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "id": "example",
    "image": "example",
    "mounts": {
      "persistent": {
        "path": "example",
        "size": 10
      }
    },
    "name": "example",
    "ports": [],
    "public": false,
    "registry": null,
    "serverless": false,
    "startJupyter": false,
    "startSsh": false
  },
  "has_more": false,
  "next_cursor": "example"
}

Get endpoint health

Get endpoint health.

Inputs

Endpointendpoint_idtextRequired
Endpoint id

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
The token for the next page, or empty when complete.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get Serverless job

Get Serverless job.

Inputs

Endpointendpoint_idtextRequired
Endpoint id
Job IDjob_idtextRequired
The job ID returned when the job was submitted.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
The token for the next page, or empty when complete.
Example output
{
  "data": {
    "id": "example",
    "output": {},
    "status": "example",
    "stream": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Get streamed job results

Get streamed job results.

Inputs

Endpointendpoint_idtextRequired
Endpoint id
Job IDjob_idtextRequired
The job ID returned when the job was submitted.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
The token for the next page, or empty when complete.
Example output
{
  "data": {
    "id": "example",
    "output": {},
    "status": "example",
    "stream": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List network volumes

List network volumes.

Inputs

Cursorcursortext
Opaque resume cursor : pass the previous response's `pagination.nextCursor` through verbatim; omit for the first page. A cursor is only valid for the operation and parameters that issued it; a malformed or foreign cursor is rejected with 422.
Limitlimitnumber
Page size, 1to1000. Defaults to 1000 when omitted.From 1 to 1000.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "networkVolumes": [],
    "pagination": {
      "hasNextPage": false,
      "nextCursor": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}

List pods

List pods.

Inputs

IncludeClusterPodsincludeClusterPodstrue/false
Include cluster member pods in the result. Defaults to false.
Cursorcursortext
Opaque resume cursor : pass the previous response's `pagination.nextCursor` through verbatim; omit for the first page. A cursor is only valid for the operation and parameters that issued it; a malformed or foreign cursor is rejected with 422.
Limitlimitnumber
Page size, 1to1000. Defaults to 1000 when omitted.From 1 to 1000.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "pagination": {
      "hasNextPage": false,
      "nextCursor": null
    },
    "pods": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List serverless endpoint workers

List serverless endpoint workers.

Inputs

EndpointidtextRequired
Serverless endpoint identifier

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "endpointVersion": null,
    "summary": {
      "idle": 0,
      "initializing": 0,
      "running": 0,
      "throttled": 0,
      "total": 0,
      "unhealthy": 0
    },
    "workers": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List serverless endpoints

List serverless endpoints.

Inputs

Cursorcursortext
Opaque resume cursor : pass the previous response's `pagination.nextCursor` through verbatim; omit for the first page. A cursor is only valid for the operation and parameters that issued it; a malformed or foreign cursor is rejected with 422.
Limitlimitnumber
Page size, 1to1000. Defaults to 1000 when omitted.From 1 to 1000.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "endpoints": [],
    "pagination": {
      "hasNextPage": false,
      "nextCursor": null
    }
  },
  "has_more": false,
  "next_cursor": "example"
}

List templates

List templates.

Inputs

Cursorcursortext
Opaque resume cursor : pass the previous response's `pagination.nextCursor` through verbatim; omit for the first page. A cursor is only valid for the operation and parameters that issued it; a malformed or foreign cursor is rejected with 422.
Limitlimitnumber
Page size, 1to1000. Defaults to 1000 when omitted.From 1 to 1000.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "pagination": {
      "hasNextPage": false,
      "nextCursor": null
    },
    "templates": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Run Serverless job

Run Serverless job.

Inputs

Endpointendpoint_idtextRequired
Endpoint id
Job inputjob_inputobjectRequired
The input object expected by your endpoint’s worker.
Webhookwebhooktext
HTTPS address to receive the completed job.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
The token for the next page, or empty when complete.
Example output
{
  "data": {
    "id": "example",
    "output": {},
    "status": "example",
    "stream": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Run Serverless job and wait

Submit a Serverless job and wait briefly for a result. If it is still running, use the returned job ID with Get Serverless job; resubmitting creates another paid job.

Inputs

Endpointendpoint_idtextRequired
Endpoint id
Job inputjob_inputobjectRequired
The input object expected by your endpoint’s worker.
Waitwaitnumber
Maximum wait in milliseconds. A job may continue in the background after this wait.From 1000 to 50000.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
The token for the next page, or empty when complete.
Example output
{
  "data": {
    "id": "example",
    "output": {},
    "status": "example",
    "stream": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Terminate a pod

Terminate a pod.

Inputs

PodidtextRequired
Pod identifier

Outputs

datanull
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Trigger a pod state transition

Trigger a pod state transition.

Inputs

PodidtextRequired
Id
Actionpod_actiontextRequired
State transition to trigger on a pod.One of: start, stop, restart, terminate.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "actions": [],
    "args": "example",
    "cloud": "SECURE",
    "cluster": {
      "id": "example",
      "ip": "example",
      "rank": null,
      "role": "SLURM_CONTROLLER"
    },
    "cmd": [],
    "cost": 0,
    "cpu": {
      "id": "example",
      "memory": 1,
      "vcpuCount": 2
    },
    "createdAt": "2026-01-01T00:00:00Z",
    "cudaVersion": null,
    "dataCenterId": null,
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "globalNetworking": {
      "enabled": false,
      "internalDns": "example",
      "ip": "example"
    },
    "gpu": {
      "count": 1,
      "id": "example",
      "memory": 1,
      "vcpuCount": 1
    },
    "id": "example",
    "image": "example",
    "locked": false,
    "mounts": {
      "global": [],
      "network": [],
      "persistent": {
        "path": "example",
        "size": 10
      }
    },
    "name": "example",
    "ports": [],
    "registry": null,
    "runtime": null,
    "ssh": {
      "direct": null,
      "proxy": null
    },
    "startedAt": null,
    "status": "PROVISIONING",
    "template": null
  },
  "has_more": false,
  "next_cursor": "example"
}

Update a template

Update a template.

Inputs

TemplateidtextRequired
Id
Container argumentscontainer_argstext
The container's command, as a single raw string. This is the field `entrypoint` and `cmd` encode into, exposed in its stored form. Two shapes are accepted. A bare shell string is treated as CMD and split into arguments, which is what the console's "Container start command" field writes. A JSON object of the form `{"entrypoint":[...],"cmd":[...]}` sets either or both explicitly. Responses always return both representations: `args` exactly as stored, plus the deconstructed `entrypoint` and `cmd`. Supplying `args` together with `entrypoint` or `cmd` is allowed only when they describe the same command, so a read-modify-write client can send back everything it received. Send `""` to clear, omit to leave unchanged.
Cmdcmdlist
Container CMD in exec form. When the image defines an ENTRYPOINT, this is the argument list passed to it. Encoded into the `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Entrypointentrypointlist
Container ENTRYPOINT in exec form, overriding the image's own. Encoded into `args` field; supplying both is allowed only when they describe the same command. Send `[]` to clear, omit to leave unchanged.
Diskdisknumber
Container disk in GB (ephemeral, wiped on restart)At least 1.
Envenvobject
Environment variables as key-value pairs
Imageimagetext
Docker image reference
Portsportslist
Exposed ports, formatted as port/protocol
Registryregistrytext
Container registry credential ID (for private images)
AllowedCudaVersionsallowedCudaVersionslist
Acceptable CUDA versions for pods created from this template. An explicit `[]` clears the constraint; omitting the field leaves it unchanged.
Categorycategorytext
Controls how the template is grouped and filtered in the Runpod console. It does not affect hardware selection, scheduling, or billing. - `CPU` : CPU-only workloads - `NVIDIA` : NVIDIA GPU workloads - `AMD` : AMD GPU workloadsOne of: CPU, NVIDIA, AMD.
Mountsmountsobject
Storage mounts attached to a template. Templates support only a single persistent mount today; any `network` property is rejected with 422 by the schema validator. PATCH semantics: omitting `mounts` or sending `{}` leaves the existing mount unchanged.
Namenametext
Name
Publicpublictrue/false
Public
Serverlessserverlesstrue/false
Serverless
StartJupyterstartJupytertrue/false
Start JupyterLab at container startup (`JUPYTER_PASSWORD` env injection). See the create-time field for details.
StartSshstartSshtrue/false
Provision SSH access at container startup (`PUBLIC_KEY` env injection). See the create-time field for details.

Outputs

dataobject
The response returned by the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation token for the next page.
Example output
{
  "data": {
    "allowedCudaVersions": [],
    "args": "example",
    "category": "CPU",
    "cmd": [],
    "disk": 1,
    "entrypoint": [],
    "env": {},
    "id": "example",
    "image": "example",
    "mounts": {
      "persistent": {
        "path": "example",
        "size": 10
      }
    },
    "name": "example",
    "ports": [],
    "public": false,
    "registry": null,
    "serverless": false,
    "startJupyter": false,
    "startSsh": false
  },
  "has_more": false,
  "next_cursor": "example"
}

On this page