Skip to content
GitmoapAPIBeta
Buildpipeline-runs
GET/repositories/{repo_id}/pipeline-runs/{pipeline_run_id}/status

A run's status in compact form, for polling.

get_pipeline_run_status
  • pipeline:read
    A token needs the pipeline:read scope: View pipeline runs and definitionsGranted by read_api, read_repository, write_api, write_repository.Every operation this scope unlocks
  • Conditional · 304
    Declares 304 Not Modified.

Send the response's ETag back as If-None-Match and the answer is 304 Not Modified until the run changes.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository id
  • pipeline_run_idPipelineRunId (string · uuid)Pipeline run id

Responses

200The run's compact status (carries an ETag)application/json
  • nodesarray of NodeStatusEntry
    • The NodeStatusEntry schema
    • attemptinteger · int320–∞
    • node_idNodeId (string)
    • node_run_idNodeRunId (string · uuid)
    • statusNodeStatuspendingawaiting_approvaldispatchedrunningsucceededfailedtimed_outskippedcancelledWhere a step has got to.
    • allow_failurebooleanoptionalWhether the step is allowed to fail. A failure of such a step does not fail the run, so show it as a warning.
  • pipeline_run_idPipelineRunId (string · uuid)
  • run_terminalboolean
  • stagesarray of StageView
    • The StageView schema
    • barrier_passedbooleanWhether every step in the stage has finished, so later stages may start.
    • failed_countinteger · int320–∞Steps in the stage that failed or timed out, not counting steps allowed to fail.
    • stage_idStageId (string)
    • stage_indexinteger · int320–∞The stage's position in execution order, counting from zero.
    • terminal_countinteger · int320–∞Steps in the stage that have finished, whatever their outcome.
    • totalinteger · int320–∞Steps in the stage.
  • started_atstring
  • statusPipelineStatusrunningsucceededsucceeded_with_warningsfailedtimed_outcancelledPer-PipelineRun status.
  • versioninteger · int640–∞
  • finished_atstring or nulloptional
200 exampleSynthesized example
{
"nodes": [
{
"attempt": 3,
"node_id": "e9a2d193-345c-4df5-b13b-b1ae470075e2",
"node_run_id": "7d7c4fc3-b648-4b1c-a4f2-a51fc1e33835",
"status": "pending"
},
{
"attempt": 1,
"node_id": "326ffe39-63e0-4833-bf4e-02e3bbe50fa5",
"node_run_id": "85caf974-b907-4b2f-aac4-479c026713d6",
"status": "pending"
}
],
"pipeline_run_id": "9e2b7c41-3d5a-4f8e-b1c2-7a6d5e4f3c2b",
"run_terminal": false,
"stages": [
{
"barrier_passed": false,
"failed_count": 4,
"stage_id": "d9d681b9-4f55-4fcb-bf1f-16605bb2c32d",
"stage_index": 3,
"terminal_count": 3,
"total": 0
},
{
"barrier_passed": false,
"failed_count": 7,
"stage_id": "bb4bb8f6-31ae-4fc1-aa28-9aedfce24922",
"stage_index": 2,
"terminal_count": 0,
"total": 1
}
],
"started_at": "2026-10-14T02:16:08Z",
"status": "running",
"version": 31,
"finished_at": "2026-10-12T07:08:21Z"
}
304Not modified (If-None-Match matched the current version)

No body.

400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-745a",
"message": "Draw the region map from operation density"
}
}
401application/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-5978",
"message": "Label every synthesized example"
}
}
403application/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-617c",
"message": "Label every synthesized example"
}
}
404application/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-2a0b",
"message": "Stream pipeline status into the run header"
}
}

CLI

gitmoap pipeline-runs get-status

  • --repo-ididRepository id (id or owner/repo path)
  • --pipeline-run-ididPipeline run id

Used in these guides