Skip to main content
PATCH
Name an Execution Run

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

cluster_id
string
required

Cluster ID

run_id
string
required

Run ID to name

Body

application/json

Body for PATCH /v1/clusters/{cluster_id}/executions/{run_id}/name.

Names (or renames) a single execution run without re-running clustering. The value is trimmed; an empty string (after trimming) CLEARS the name, restoring the unnamed state (run_id-only display). Strict single-field model — the run name is the only mutable display field here, mirroring the field-scoped .../labels PATCH.

run_name
string
required

Human-friendly name for the run (e.g. 'July tuning baseline'). Trimmed; a non-empty value sets/replaces the name, an empty string clears it. Capped at 120 characters.

Examples:

"July tuning baseline"

""

Response

Successful Response

Response for PATCH .../executions/{run_id}/name: the persisted name.

cluster_id
string
required

Cluster the execution belongs to

run_id
string
required

Execution whose name was patched

run_name
string | null

The run's name AFTER applying this patch. None when the name was just cleared (empty-string request).