Xeonr Developer Docs

Get Pipeline Run Status

POST
/uplim.api.v1.InternalPipelineRunsService/GetPipelineRunStatus

Cheap status poll the coordinator uses (about every 2 seconds while a step runs) to notice an admin cancel. Returns the run's status and, when set, its failure message (the cancel reason). NotFound for an unknown run.

Access: internal only — the pipeline coordinator, authenticated by the shared X-Upl-Internal-Token header matching PIPELINE_INTERNAL_TOKEN (FailedPrecondition when unset, Unauthenticated on mismatch). No user authentication.

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

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

runId?string
Formatuuid
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.InternalPipelineRunsService/GetPipelineRunStatus" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "status": "PIPELINE_RUN_STATUS_UNSPECIFIED",
  "failureMessage": "string"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}