Approve the current step
Satisfies the holdConditions.requiresApproval gate on the current step of
a running schedule.
Approval is the final gate: it can only be granted once every other hold
on the step has already cleared. This endpoint rejects the request (400) if
the step is not yet ready for approval — for example while the interval timer
is still counting down, or (for monitored steps) before fresh analysis
covering the step is available or while a guardrail/health signal is failing.
Poll the /status endpoint and only call this once it reports the step is
awaiting approval.
Non-monitored steps: once the interval has elapsed, approving clears the last hold and the schedule advances immediately, chaining through any subsequent instant steps in the same request.
Monitored steps: once the interval has elapsed and fresh, healthy analysis is available, approving clears the last hold and the agenda advances the step on its next tick (re-checking the latest analysis once more first).
Different from /actions/advance: approve-step works within the normal
evaluation flow and refuses to skip ahead of the interval or any other
unmet gate. Use /actions/advance only if you want to bypass all remaining
holds entirely (including the interval timer).
Requires feature review permissions for the associated feature.
curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step', 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/approve-step",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/approve-step")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
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
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
Response
Resource created
Show child attributes
Show child attributes
Was this page helpful?
curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step', 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/approve-step",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/approve-step")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/ramp-schedules/{id}/actions/approve-step")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
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"
}
}
}
