Skip to content
GitmoapAPIBeta
Schema

Deployment

One deploy of one service to one environment, at one commit.

Shape

  • attemptinteger · int320–∞
  • commit_shastring
  • deployment_idDeploymentId (string · uuid)The deployment's id. It is derived from the run, step and attempt that made it, so the same attempt never records two deployments.
  • environment_idEnvironmentId (string · uuid)
  • repository_idRepositoryId (string · uuid)
  • service_idServiceId (string · uuid)
  • started_atstring
  • statusDeploymentStatusrequestedawaiting_approvalrejectedrunningsucceededfailedcancelledsupersededskippedWhere a deployment is in its life. It starts requested; waits as awaiting_approval when the environment needs approval, ending rejected if refused; then running, ending succeeded, failed or cancelled. skipped means another deploy held the environment and its policy is to skip. A successful deployment becomes superseded when a later one replaces it.
  • approved_byActorSummary or nulloptional
  • error_summarystring or nulloptional
  • finished_atstring or nulloptional
  • node_idstring or nulloptional
  • pipeline_run_idPipelineRunId (string · uuid) or nulloptionalThe pipeline run that made the deployment. Absent once that run's history has been removed; the deployment record is kept.
  • ref_namestring or nulloptional
  • triggered_byActorSummary or nulloptional

Example

Synthesized example
{
"attempt": 4,
"commit_sha": "9c8bf1dbae4cee4639131508664fe50764a852ad",
"deployment_id": "504c8e0d-f041-4d4b-864e-36773a903da4",
"environment_id": "7aae97ac-fdbe-46f8-a2f4-1a5b7ee96b63",
"repository_id": "5b0e7c2a-9d14-4e8b-a6f1-2c3d4e5f6a70",
"service_id": "323a1931-319b-4923-a13d-c4f441b7a380",
"started_at": "2026-10-14T03:02:34Z",
"status": "requested",
"approved_by": {
"email": "tomas@acme.example",
"id": "id-16f1",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/b5a6fc5b"
},
"error_summary": "error-summary-61d7",
"finished_at": "2026-10-15T08:51:02Z",
"node_id": "3cfe7e11-5a44-420b-afeb-d8fe063f004a",
"pipeline_run_id": "9e2b7c41-3d5a-4f8e-b1c2-7a6d5e4f3c2b",
"ref_name": "payments-api",
"triggered_by": {
"email": "mara@acme.example",
"id": "id-b8dd",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/33c20f67"
}
}

Graph

Contains

Used by

Sent by 0 operations

No operation takes it as a request body.

Returned by 0 operations

No operation returns it directly.