Skip to main content
PATCH
Required API key scope: tags:write

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

Tag identifier.

Minimum string length: 1

Body

application/json

The fields to change; omitted fields are unchanged. Resources the tag is attached to stay attached.

key
string

Tag key, 1–191 characters as sent, with at least one that is not whitespace. Leading and trailing whitespace is ignored. Keys under the reserved runpod: prefix, in any letter case, are rejected.

Required string length: 1 - 191
Pattern: [^\t-\r …   - 

   ]
Example:

"env"

value
string

Tag value, at most 191 characters. May be empty. Stored exactly as sent, whitespace included.

Maximum string length: 191
Example:

"dev"

Response

OK

id
string
required

Shared by every resource the tag is attached to.

Example:

"clz1x9k4a0000qw3h8s7d2f1g"

key
string
required

Returned exactly as stored.

Example:

"env"

value
string
required

Returned exactly as stored. May be empty.

Example:

"dev"

createdAt
string<date-time>
required
Example:

"2026-11-04T09:00:00Z"

updatedAt
string<date-time>
required
Example:

"2026-11-04T09:00:00Z"

Last modified on November 18, 2026