Pause a ramp schedule

Pauses a running or pending-approval schedule. The schedule can be resumed from the same position with the /actions/resume endpoint.

POST /ramp-schedules/{id}/actions/pause

cURL

cURL

curl -X POST https://api.growthbook.io/api/v1/ramp-schedules/rs_abc123/actions/pause \
  -u secret_abc123DEF456:

200

{
  "rampSchedule": {
    "id": "<string>",
    "organization": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "entityType": "feature",
    "entityId": "<string>",
    "targets": [
      {
        "id": "<string>",
        "entityType": "feature",
        "entityId": "<string>",
        "status": "pending-join",
        "ruleId": "<string>",
        "environment": "<string>",
        "activatingRevisionVersion": 123
      }
    ],
    "steps": [
      {
        "trigger": {
          "type": "interval",
          "seconds": 123,
          "at": "2023-11-07T05:31:56Z"
        },
        "actions": [
          {
            "targetType": "feature-rule",
            "targetId": "<string>",
            "patch": {
              "ruleId": "<string>",
              "coverage": 0.5,
              "condition": "<string>",
              "force": "<unknown>"
            }
          }
        ],
        "approvalNotes": "<string>"
      }
    ],
    "status": "pending",
    "currentStepIndex": 0,
    "nextStepAt": "2023-11-07T05:31:56Z",
    "endActions": [
      {
        "targetType": "feature-rule",
        "targetId": "<string>",
        "patch": {
          "ruleId": "<string>",
          "coverage": 0.5,
          "condition": "<string>",
          "force": "<unknown>"
        }
      }
    ],
    "startDate": "2023-11-07T05:31:56Z",
    "endCondition": {
      "trigger": {
        "type": "scheduled",
        "at": "2023-11-07T05:31:56Z"
      }
    },
    "startedAt": "2023-11-07T05:31:56Z",
    "phaseStartedAt": "2023-11-07T05:31:56Z",
    "pausedAt": "2023-11-07T05:31:56Z",
    "elapsedMs": 123
  }
}

Authorizations

bearerAuthbasicAuth

Authorization · string · header · required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1 \
  -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

id · string · required

The id of the requested resource

Response

200 - application/json

Success

rampSchedule · object · required

Show child attributes