Xeonr Developer Docs
UplApiuplim.api.v1.PipelineAdminService

CancelPipelineRun

POST
/uplim.api.v1.PipelineAdminService/CancelPipelineRun

Cancels an in-flight run. Side effects:

  • marks the run CANCELLED with the operator's optional reason
  • marks any QUEUED step rows SKIPPED, RUNNING step rows CANCELLED
  • deletes the running step's k8s Job (which sends SIGTERM → SIGKILL to the pod after terminationGracePeriod) Idempotent on terminal-status runs (returns the current state without changes). audit-DDD.

Authorization

AuthorizationBearer <token>

JWT access token obtained via OAuth2 flow or service account

In: header

Header Parameters

Connect-Protocol-Version*number

Define the version of the Connect protocol

Value in1
Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

id?string
Formatuuid
reason?string

Optional operator note explaining why the run was cancelled. Stored in PipelineRun.failure_message. Surfaced in the run-detail UI so the next viewer understands the cancel without context.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.PipelineAdminService/CancelPipelineRun" \  -H "Connect-Protocol-Version: 1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "run": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "snapshotId": "09520abc-01e6-4da1-8fa5-f10e3883c861",
    "integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
    "bucketId": "string",
    "trigger": "PIPELINE_RUN_TRIGGER_UNSPECIFIED",
    "resource": {
      "kind": "PIPELINE_RESOURCE_KIND_UNSPECIFIED",
      "folderId": "string"
    },
    "batchId": "string",
    "status": "PIPELINE_RUN_STATUS_UNSPECIFIED",
    "failureClass": "STEP_FAILURE_CLASS_UNSPECIFIED",
    "failureStepId": "string",
    "failureMessage": "string",
    "stepRuns": [
      {
        "stepId": "string",
        "parentStepId": "string",
        "status": "STEP_RUN_STATUS_UNSPECIFIED",
        "attempt": 0,
        "failureClass": "STEP_FAILURE_CLASS_UNSPECIFIED",
        "failureMessage": "string",
        "resolvedInputsJson": "string",
        "blobOutputNames": [
          "string"
        ],
        "kvOutputKeys": [
          "string"
        ],
        "localOutputNames": [
          "string"
        ],
        "localBlobNames": [
          "string"
        ],
        "logsObjectKey": "string",
        "logsTruncated": true,
        "utilisation": {
          "cpuMilliseconds": 0,
          "wallTimeMs": 0,
          "blobBytesWritten": 0,
          "kvWrites": 0,
          "httpCallsOutbound": 0,
          "peakMemoryBytes": 0
        },
        "startedAt": "2023-01-15T01:30:15.01Z",
        "finishedAt": "2023-01-15T01:30:15.01Z"
      }
    ],
    "supersededByRunId": "458849c9-1a7a-4314-b11d-cb996f79bcdf",
    "pipelineUrn": "string",
    "enqueuedAt": "2023-01-15T01:30:15.01Z",
    "startedAt": "2023-01-15T01:30:15.01Z",
    "finishedAt": "2023-01-15T01:30:15.01Z",
    "traceRunId": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}