Pause a rollout

POST

/api/v1/deployments/{id}/pause

const url = 'http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pause';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/pause \
  --header 'X-API-Key: <X-API-Key>'

Pauses the rollout at the current batch boundary.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Deployment UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Rollout paused successfully

application/json

object

phase

required

string

Allowed values: PENDING CANARY_DEPLOYING CANARY_VALIDATING CANARY_PROMOTED ROLLING_IN_PROGRESS PAUSED COMPLETED ROLLED_BACK

strategy

required

string

Allowed values: IMMEDIATE CANARY ROLLING

totalInstances

required

number

pendingInstances

required

number

deployingInstances

required

number

runningInstances

required

number

failedInstances

required

number

currentBatch

required

number

totalBatches

required

number

canaryInstances

required

number

productionInstances

required

number

failureRate

required

Share of failed instances

number

isRollbackTriggered

required

boolean

canarySuccessWindowMinutes

Canary success window in minutes. Only for a CANARY rollout in CANARY_DEPLOYING or CANARY_VALIDATING.

number

canarySuccessWindowRemainingMinutes

Minutes left in the canary success window; 0 once it has elapsed. Absent while the rollout has not started.

number

Example

{
  "phase": "PENDING",
  "strategy": "IMMEDIATE"
}

403

Forbidden — caller lacks required permission

404

Deployment not found