Pause a trail's rollout
Pause the release controller on a trail: it stops stepping the flag and watching the guards until the rollout is resumed. The flag stays wherever it is. A…
Pause the release controller on a trail: it stops stepping the flag and watching the guards until the rollout is resumed. The flag stays wherever it is. A trail that ships behind several flags has a rollout per flag; pass resource (the flag's trail-resource id or its key) to pause one, or omit it to pause every flag. Any manual change to the flag pauses the controller the same way, so a person and the controller never fight over it. Safe to call at any time; pausing a rollout that is not running answers 409.
Safe for the restricted ops key.
The checkout flag is at 25% and a deploy is going out; hold the ramp until it is done.
Authorization
bearerSdkKey Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".
In: header
Path Parameters
The trail's handle (T-12) or its id.
^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$1 <= length <= 64Header Parameters
Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://shipeasy.ai/api/admin/trails/string/rollout/pause" \ -H "Content-Type: application/json" \ -d '{ "reason": "Deploy window" }'{
"rollout": {
"resource": {
"id": "string",
"key": "string"
},
"state": "idle",
"config": {
"steps": [
1,
5,
25,
50,
100
],
"holdMinutes": 0,
"minExposure": 0,
"internal": {
"holdMinutes": 0
},
"guards": {
"alertRuleIds": [
"string"
],
"attributedErrors": true
},
"policies": {
"onBreach": "pull_back",
"breachTimeoutMinutes": 1,
"advance": "auto",
"afterFix": "resume"
}
},
"step": 0,
"stepPct": 0,
"stepStartedAt": "string",
"pausedReason": "string",
"pending": {
"kind": "breach",
"questionId": "string",
"askedAt": "string"
}
},
"rollouts": [
{
"resource": {
"id": "string",
"key": "string"
},
"state": "idle",
"config": {
"steps": [
1,
5,
25,
50,
100
],
"holdMinutes": 0,
"minExposure": 0,
"internal": {
"holdMinutes": 0
},
"guards": {
"alertRuleIds": [
"string"
],
"attributedErrors": true
},
"policies": {
"onBreach": "pull_back",
"breachTimeoutMinutes": 1,
"advance": "auto",
"afterFix": "resume"
}
},
"step": 0,
"stepPct": 0,
"stepStartedAt": "string",
"pausedReason": "string",
"pending": {
"kind": "breach",
"questionId": "string",
"askedAt": "string"
}
}
]
}{
"error": "Malformed request (bad JSON, missing project scope).",
"code": "BAD_REQUEST"
}{
"error": "Missing or invalid admin SDK key.",
"code": "UNAUTHORIZED"
}{
"error": "Key is valid but not allowed to act on this project.",
"code": "FORBIDDEN"
}{
"error": "The resource does not exist or is not visible to the caller.",
"code": "NOT_FOUND"
}{
"error": "A resource with this name already exists in the project.",
"code": "ALREADY_EXISTS"
}{
"error": "The request body failed structural (schema) validation.",
"code": "VALIDATION"
}Read a trail's release facts
The traffic is read from proxy when given (metric:<key>, event:<name> or flag:<key>), else the trail's goal metric, else a flag already on the trail. With…
Resume a trail's rollout
Hand a paused rollout back to the release controller. Pass resource (the flag's trail-resource id or its key) to resume one flag's rollout, or omit it to…