Create deployment

Requires cicd.deploy PLUS authority on the target environment (see whoami.environments) — the authority check this API’s absence used to force teams onto Artemis Git for. The qualification gate is enforced asynchronously by the deploy worker; poll statusUrl/jobStatusUrl.

POST /api/cicd/v1/projects/{projectId}/deployments

Error

A valid request URL is required to generate request examples

202

{
  "success": true,
  "deploymentId": "<string>",
  "jobId": "<string>",
  "statusUrl": "<string>",
  "jobStatusUrl": "<string>"
}

Deploy a “ready” release to an environment.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

projectId · string · required

UUID v7; must be in the key/token's projectIds.

Body

application/json

releaseId · string · required

The ready release to deploy.

Minimum string length: 1

environment · enum<string> · required

Available options: dev, staging, production

bypassQualificationGate · boolean

Requires scope cicd.gate.bypass.

bypassReason · string

Required audit reason when bypassing.

Response

202

application/json

Deploy started

success · boolean · required

deploymentId · string · required

Id of the (new) deployment this action created.

jobId · string · required

cicd-deploy-<deploymentId>.

statusUrl · string

jobStatusUrl · string