Shipeasy
APIOperations

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…

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 resume every paused flag on the trail. It reconciles with the flag wherever a person left it (the highest step at or below the flag's percent, snapping the flag onto that step), restarts the step's hold, and carries on. A rollout that was pulled back and is waiting for its fix resumes as fixing. Resuming a rollout that is not paused answers 409.

Resuming is a person's call: it hands the flag back to automation. Only a dashboard session or a device-auth CLI session can resume — ops keys, project admin keys and OAuth MCP calls are refused with 403. This operation is not exposed as an MCP tool.

Use case

After steering the flag by hand, give the ramp back to the controller.

POST
/api/admin/trails/{handle}/rollout/resume

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

handle*string

The trail's handle (T-12) or its id.

Match^(?:T-[0-9]+|[0-9a-fA-F-]{32,36})$
Length1 <= length <= 64

Header Parameters

X-Project-Id?string

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/resume" \  -H "Content-Type: application/json" \  -d '{    "reason": "Deploy is done"  }'
{
  "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"
}

Was this page helpful?