Advance to the next step, overriding any holds

Moves the schedule to the next step, bypassing all hold conditions — interval, min sample size, and monitoring signal holds. Accepts running or paused status; if paused, the schedule is implicitly resumed (timing anchors recalculated) before the step moves.

Approval gate: if the current step has an unsatisfied holdConditions.requiresApproval gate, this endpoint returns 409 by default. Either call /actions/approve-step first (recommended), or pass force: true to override the approval gate. force: true requires canBypassApprovalChecks permission and is logged in the audit trail.

Two common uses:

Post-interval monitoring hold (decision: "hold", interval elapsed): the step timer has completed but a signal or guardrail is flagging concern. Use this after reviewing the /status health summary and deciding to accept the risk and proceed.
Hard override: skip a step regardless of where it is in its interval or hold conditions (CI gate, external deployment pipeline).

When to use other actions instead:

/actions/resume — restores a paused schedule without moving the step.
/actions/approve-step — clears only the approval gate; other conditions still resolve naturally.
/actions/rollback — preferred response when decision: "rollback" or signals include guardrail-failing.

POST

ramp-schedules

{id}

actions

advance

cURL

curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance"

payload = {
    "reason": "<string>",
    "force": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', force: true})
};

fetch('https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'force' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"force\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"force\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"force\": true\n}"

response = http.request(request)
puts response.read_body

{
  "rampSchedule": {
    "id": "<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>",
        "ruleId": "<string>",
        "environment": "<string>",
        "activatingRevisionVersion": 123
      }
    ],
    "steps": [
      {
        "interval": 1,
        "actions": [
          {
            "targetType": "feature-rule",
            "targetId": "<string>",
            "patch": {
              "ruleId": "<string>",
              "coverage": 0.5,
              "condition": "<string>",
              "savedGroups": [
                {
                  "ids": [
                    "<string>"
                  ]
                }
              ],
              "prerequisites": [
                {
                  "id": "<string>",
                  "condition": "<string>"
                }
              ],
              "allEnvironments": true,
              "environments": [
                "<string>"
              ],
              "force": "<unknown>",
              "enabled": true
            }
          }
        ],
        "approvalNotes": "<string>",
        "monitored": true,
        "holdConditions": {
          "minSampleSize": 123,
          "requiresApproval": true
        }
      }
    ],
    "currentStepIndex": 0,
    "nextStepAt": "2023-11-07T05:31:56Z",
    "startActions": [
      {
        "targetType": "feature-rule",
        "targetId": "<string>",
        "patch": {
          "ruleId": "<string>",
          "coverage": 0.5,
          "condition": "<string>",
          "savedGroups": [
            {
              "ids": [
                "<string>"
              ]
            }
          ],
          "prerequisites": [
            {
              "id": "<string>",
              "condition": "<string>"
            }
          ],
          "allEnvironments": true,
          "environments": [
            "<string>"
          ],
          "force": "<unknown>",
          "enabled": true
        }
      }
    ],
    "endActions": [
      {
        "targetType": "feature-rule",
        "targetId": "<string>",
        "patch": {
          "ruleId": "<string>",
          "coverage": 0.5,
          "condition": "<string>",
          "savedGroups": [
            {
              "ids": [
                "<string>"
              ]
            }
          ],
          "prerequisites": [
            {
              "id": "<string>",
              "condition": "<string>"
            }
          ],
          "allEnvironments": true,
          "environments": [
            "<string>"
          ],
          "force": "<unknown>",
          "enabled": true
        }
      }
    ],
    "startDate": "2023-11-07T05:31:56Z",
    "cutoffDate": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "phaseStartedAt": "2023-11-07T05:31:56Z",
    "pausedAt": "2023-11-07T05:31:56Z",
    "nextProcessAt": "2023-11-07T05:31:56Z",
    "elapsedMs": 123,
    "lockdownConfig": {},
    "monitoringConfig": {
      "datasourceId": "<string>",
      "exposureQueryId": "<string>",
      "guardrailMetricIds": [
        "<string>"
      ],
      "signalMetricIds": [
        "<string>"
      ],
      "updateScheduleMinutes": 11,
      "autoUpdate": true,
      "noTrafficGracePeriodHours": 1
    },
    "currentStepEnteredAt": "2023-11-07T05:31:56Z",
    "stepApproval": {
      "stepIndex": 123,
      "approvedAt": "2023-11-07T05:31:56Z",
      "approvedBy": "<string>"
    },
    "monitoringStartDate": "2023-11-07T05:31:56Z",
    "lastRollbackAt": "2023-11-07T05:31:56Z",
    "lastRollbackReason": "<string>",
    "monitoringStatus": {
      "autoUpdate": true,
      "effectiveAutoUpdate": true,
      "currentStepMonitored": true,
      "safeRolloutId": "<string>",
      "blockedReason": "<string>",
      "nextSnapshotAt": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

Authorization

string

header

required

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

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

Path Parameters

string

required

Body

application/json

reason

string

Reason for advancing

force

boolean

Bypass a pending approval gate on the current step. Requires admin-level (canBypassApprovalChecks) permission. When omitted or false, a 409 is returned if the step has an unsatisfied holdConditions.requiresApproval gate.

Response

200 - application/json

Resource created

rampSchedule

object

required

Show child attributes

cURL

curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance"

payload = {
    "reason": "<string>",
    "force": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', force: true})
};

fetch('https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'force' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"force\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"force\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/advance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"force\": true\n}"

response = http.request(request)
puts response.read_body

{
  "rampSchedule": {
    "id": "<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>",
        "ruleId": "<string>",
        "environment": "<string>",
        "activatingRevisionVersion": 123
      }
    ],
    "steps": [
      {
        "interval": 1,
        "actions": [
          {
            "targetType": "feature-rule",
            "targetId": "<string>",
            "patch": {
              "ruleId": "<string>",
              "coverage": 0.5,
              "condition": "<string>",
              "savedGroups": [
                {
                  "ids": [
                    "<string>"
                  ]
                }
              ],
              "prerequisites": [
                {
                  "id": "<string>",
                  "condition": "<string>"
                }
              ],
              "allEnvironments": true,
              "environments": [
                "<string>"
              ],
              "force": "<unknown>",
              "enabled": true
            }
          }
        ],
        "approvalNotes": "<string>",
        "monitored": true,
        "holdConditions": {
          "minSampleSize": 123,
          "requiresApproval": true
        }
      }
    ],
    "currentStepIndex": 0,
    "nextStepAt": "2023-11-07T05:31:56Z",
    "startActions": [
      {
        "targetType": "feature-rule",
        "targetId": "<string>",
        "patch": {
          "ruleId": "<string>",
          "coverage": 0.5,
          "condition": "<string>",
          "savedGroups": [
            {
              "ids": [
                "<string>"
              ]
            }
          ],
          "prerequisites": [
            {
              "id": "<string>",
              "condition": "<string>"
            }
          ],
          "allEnvironments": true,
          "environments": [
            "<string>"
          ],
          "force": "<unknown>",
          "enabled": true
        }
      }
    ],
    "endActions": [
      {
        "targetType": "feature-rule",
        "targetId": "<string>",
        "patch": {
          "ruleId": "<string>",
          "coverage": 0.5,
          "condition": "<string>",
          "savedGroups": [
            {
              "ids": [
                "<string>"
              ]
            }
          ],
          "prerequisites": [
            {
              "id": "<string>",
              "condition": "<string>"
            }
          ],
          "allEnvironments": true,
          "environments": [
            "<string>"
          ],
          "force": "<unknown>",
          "enabled": true
        }
      }
    ],
    "startDate": "2023-11-07T05:31:56Z",
    "cutoffDate": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "phaseStartedAt": "2023-11-07T05:31:56Z",
    "pausedAt": "2023-11-07T05:31:56Z",
    "nextProcessAt": "2023-11-07T05:31:56Z",
    "elapsedMs": 123,
    "lockdownConfig": {},
    "monitoringConfig": {
      "datasourceId": "<string>",
      "exposureQueryId": "<string>",
      "guardrailMetricIds": [
        "<string>"
      ],
      "signalMetricIds": [
        "<string>"
      ],
      "updateScheduleMinutes": 11,
      "autoUpdate": true,
      "noTrafficGracePeriodHours": 1
    },
    "currentStepEnteredAt": "2023-11-07T05:31:56Z",
    "stepApproval": {
      "stepIndex": 123,
      "approvedAt": "2023-11-07T05:31:56Z",
      "approvedBy": "<string>"
    },
    "monitoringStartDate": "2023-11-07T05:31:56Z",
    "lastRollbackAt": "2023-11-07T05:31:56Z",
    "lastRollbackReason": "<string>",
    "monitoringStatus": {
      "autoUpdate": true,
      "effectiveAutoUpdate": true,
      "currentStepMonitored": true,
      "safeRolloutId": "<string>",
      "blockedReason": "<string>",
      "nextSnapshotAt": "2023-11-07T05:31:56Z"
    }
  }
}

Introduction

Endpoints

Models

Advance to the next step, overriding any holds

Authorizations

Path Parameters

Body

Response