Cluster Executions

Name an Execution Run

Changed on

Set (or clear) a human-friendly name on a single execution run — no re-run required.

A non-empty value sets/replaces the run's `run_name`; an empty string
clears it, restoring the unnamed (run_id-only) state. Names are trimmed
and capped at 120 characters. The name is persisted on the execution
record and returned by execution GET/LIST responses (`run_name`,
omitted entirely while unnamed), so run selectors and execution-history
views can show 'July tuning baseline' instead of `run_a8e2709532...`.

Sibling of PATCH `.../executions/{run_id}/labels`: each display field
gets its own strict single-purpose PATCH rather than a general
execution PATCH, because execution results themselves are immutable.

Example body: `{"run_name": "July tuning baseline"}` (or
`{"run_name": ""}` to clear).
patch/v1/clusters/{cluster_id}/executions/{run_id}/name

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/clusters/{cluster_id}/executions/{run_id}/name
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

cluster_idstring required

Cluster ID

run_idstring required

Run ID to name

Request body

run_namestring 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.

Example request

{
  "run_name": "July tuning baseline"
}

Response

Successful Response

cluster_idstring required

Cluster the execution belongs to

run_idstring required

Execution whose name was patched

run_namestring nullable

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

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API