Skip to main content
GET
Get a template

Authorizations

Authorization
string
header
required

Runpod API key authentication. Generate an API key in the Runpod console and send it in the Authorization header as Bearer <api_key>. Keys are scoped to the permissions granted when created; requests may return 403 when a valid key lacks access to the requested resource or action.

Console sessions (Clerk JWTs) act for the signed-in user. To act for a team instead, also send X-Team-Id: <team_id>; it applies only when the user owns or belongs to that team, otherwise the request runs against the user's own account. API keys created inside a team already act for that team and do not need the header.

Path Parameters

id
string
required

Response

OK

Reusable container configuration shared across templates, pods, serverless endpoints, and clusters. Adding a field here automatically propagates to all of them.

args
string
required

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.

Examples:

"--model meta-llama/Llama-3-8B --max-model-len 8192"

"{\"entrypoint\":[\"/bin/bash\",\"-c\"],\"cmd\":[\"python -u main.py\"]}"

""

disk
integer
required

Container disk in GB (ephemeral, wiped on restart)

Required range: x >= 1
Example:

50

env
object
required

Environment variables as key-value pairs

Example:
image
string
required

Docker image reference

Example:

"runpod/pytorch:1.0.2-cu1281-torch280-ubuntu2404"

ports
string[]
required

Exposed ports, formatted as port/protocol

Example:
registry
string | null
required

Container registry credential ID for a private image: one of your credentials from /v2/registries. Leave it unset for a private Amazon ECR image. Runpod pulls those with an ECR delegation (/v2/registries/delegations) matched to the image's account, region and repository at pull time, so there is no delegation ID to pass here (a delegation ID is not a credential ID). A credential set here is used instead of any delegation.

Example:

null

id
string
required
Example:

"tpl_abc"

name
string
required
Example:

"My PyTorch Template"

mounts
object
required

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.

serverless
boolean
required

Whether this template is for serverless workers (true) or pods (false)

Example:

false

public
boolean
required

Whether this template is visible to other Runpod users

Example:

false

category
enum<string>
required

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 workloads
Available options:
CPU,
NVIDIA,
AMD
startSsh
boolean
required

Whether containers created from this template get SSH access provisioned at startup (PUBLIC_KEY env injection).

Example:

true

startJupyter
boolean
required

Whether containers created from this template start JupyterLab at startup (JUPYTER_PASSWORD env injection).

Example:

false

allowedCudaVersions
string[]
required

Acceptable CUDA versions for containers created from this template, as major.minor. Empty means any version. Expanded into GPU pod and serverless endpoint creates; CPU pods ignore it.

Example:
cmd
string[]

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.

Example:
entrypoint
string[]

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.

Example:
Last modified on October 25, 2026