Create a ramp schedule
Creates a ramp schedule, optionally attached to a published feature rule by passing featureId and ruleId together (the target is then injected into every action). Attaching on creation skips the revision review flow, so when the organization requires review anywhere it is limited to credentials that may bypass approval. The reviewed way to attach a plan is PUT /features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule followed by a publish. Without a target the schedule is a free-standing skeleton in pending status. Requires a Pro plan or above.
POST
/
v1
/
ramp-schedules
cURL
curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/ramp-schedules"
payload = {
"name": "<string>",
"featureId": "<string>",
"ruleId": "<string>",
"environment": "<string>",
"steps": [
{
"interval": 1,
"actions": [],
"approvalNotes": "<string>",
"monitored": False,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": True
}
}
],
"startActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": True,
"environments": ["<string>"],
"force": "<unknown>",
"enabled": True,
"hashAttribute": "<string>",
"seed": "<string>",
"hashVersion": 1
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"endActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": True,
"environments": ["<string>"],
"force": "<unknown>",
"enabled": True
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"cutoffDate": "2023-11-07T05:31:56Z",
"requiresStartApproval": True,
"monitoringConfig": {
"datasourceId": "<string>",
"guardrailMetricIds": ["<string>"],
"exposureQueryId": "<string>",
"signalMetricIds": ["<string>"],
"autoUpdate": True,
"autoRollback": True,
"updateScheduleMinutes": 11
},
"templateId": "<string>"
}
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({
name: '<string>',
featureId: '<string>',
ruleId: '<string>',
environment: '<string>',
steps: [
{
interval: 1,
actions: [],
approvalNotes: '<string>',
monitored: false,
holdConditions: {minSampleSize: 123, requiresApproval: true}
}
],
startActions: [
{
patch: {
ruleId: '<string>',
coverage: 0.5,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
allEnvironments: true,
environments: ['<string>'],
force: '<unknown>',
enabled: true,
hashAttribute: '<string>',
seed: '<string>',
hashVersion: 1
},
targetType: 'feature-rule',
targetId: '<string>'
}
],
endActions: [
{
patch: {
ruleId: '<string>',
coverage: 0.5,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
allEnvironments: true,
environments: ['<string>'],
force: '<unknown>',
enabled: true
},
targetType: 'feature-rule',
targetId: '<string>'
}
],
startDate: '2023-11-07T05:31:56Z',
cutoffDate: '2023-11-07T05:31:56Z',
requiresStartApproval: true,
monitoringConfig: {
datasourceId: '<string>',
guardrailMetricIds: ['<string>'],
exposureQueryId: '<string>',
signalMetricIds: ['<string>'],
autoUpdate: true,
autoRollback: true,
updateScheduleMinutes: 11
},
templateId: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/ramp-schedules', 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",
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([
'name' => '<string>',
'featureId' => '<string>',
'ruleId' => '<string>',
'environment' => '<string>',
'steps' => [
[
'interval' => 1,
'actions' => [
],
'approvalNotes' => '<string>',
'monitored' => false,
'holdConditions' => [
'minSampleSize' => 123,
'requiresApproval' => true
]
]
],
'startActions' => [
[
'patch' => [
'ruleId' => '<string>',
'coverage' => 0.5,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'allEnvironments' => true,
'environments' => [
'<string>'
],
'force' => '<unknown>',
'enabled' => true,
'hashAttribute' => '<string>',
'seed' => '<string>',
'hashVersion' => 1
],
'targetType' => 'feature-rule',
'targetId' => '<string>'
]
],
'endActions' => [
[
'patch' => [
'ruleId' => '<string>',
'coverage' => 0.5,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'allEnvironments' => true,
'environments' => [
'<string>'
],
'force' => '<unknown>',
'enabled' => true
],
'targetType' => 'feature-rule',
'targetId' => '<string>'
]
],
'startDate' => '2023-11-07T05:31:56Z',
'cutoffDate' => '2023-11-07T05:31:56Z',
'requiresStartApproval' => true,
'monitoringConfig' => [
'datasourceId' => '<string>',
'guardrailMetricIds' => [
'<string>'
],
'exposureQueryId' => '<string>',
'signalMetricIds' => [
'<string>'
],
'autoUpdate' => true,
'autoRollback' => true,
'updateScheduleMinutes' => 11
],
'templateId' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"featureId\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"environment\": \"<string>\",\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [],\n \"approvalNotes\": \"<string>\",\n \"monitored\": false,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\n }\n ],\n \"startActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true,\n \"hashAttribute\": \"<string>\",\n \"seed\": \"<string>\",\n \"hashVersion\": 1\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"endActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"cutoffDate\": \"2023-11-07T05:31:56Z\",\n \"requiresStartApproval\": true,\n \"monitoringConfig\": {\n \"datasourceId\": \"<string>\",\n \"guardrailMetricIds\": [\n \"<string>\"\n ],\n \"exposureQueryId\": \"<string>\",\n \"signalMetricIds\": [\n \"<string>\"\n ],\n \"autoUpdate\": true,\n \"autoRollback\": true,\n \"updateScheduleMinutes\": 11\n },\n \"templateId\": \"<string>\"\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"featureId\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"environment\": \"<string>\",\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [],\n \"approvalNotes\": \"<string>\",\n \"monitored\": false,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\n }\n ],\n \"startActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true,\n \"hashAttribute\": \"<string>\",\n \"seed\": \"<string>\",\n \"hashVersion\": 1\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"endActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"cutoffDate\": \"2023-11-07T05:31:56Z\",\n \"requiresStartApproval\": true,\n \"monitoringConfig\": {\n \"datasourceId\": \"<string>\",\n \"guardrailMetricIds\": [\n \"<string>\"\n ],\n \"exposureQueryId\": \"<string>\",\n \"signalMetricIds\": [\n \"<string>\"\n ],\n \"autoUpdate\": true,\n \"autoRollback\": true,\n \"updateScheduleMinutes\": 11\n },\n \"templateId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/ramp-schedules")
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 \"name\": \"<string>\",\n \"featureId\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"environment\": \"<string>\",\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [],\n \"approvalNotes\": \"<string>\",\n \"monitored\": false,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\n }\n ],\n \"startActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true,\n \"hashAttribute\": \"<string>\",\n \"seed\": \"<string>\",\n \"hashVersion\": 1\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"endActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"cutoffDate\": \"2023-11-07T05:31:56Z\",\n \"requiresStartApproval\": true,\n \"monitoringConfig\": {\n \"datasourceId\": \"<string>\",\n \"guardrailMetricIds\": [\n \"<string>\"\n ],\n \"exposureQueryId\": \"<string>\",\n \"signalMetricIds\": [\n \"<string>\"\n ],\n \"autoUpdate\": true,\n \"autoRollback\": true,\n \"updateScheduleMinutes\": 11\n },\n \"templateId\": \"<string>\"\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>",
"status": "pending-join",
"ruleId": "<string>",
"environment": "<string>",
"activatingRevisionVersion": 123
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"targetType": "feature-rule",
"targetId": "<string>",
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
}
}
],
"approvalNotes": "<string>",
"monitored": true,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": true
}
}
],
"status": "pending",
"currentStepIndex": 0,
"nextStepAt": "2023-11-07T05:31:56Z",
"awaitingApproval": true,
"startActions": [
{
"targetType": "feature-rule",
"targetId": "<string>",
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true,
"hashAttribute": "<string>",
"seed": "<string>",
"hashVersion": 1
}
}
],
"endActions": [
{
"targetType": "feature-rule",
"targetId": "<string>",
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"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",
"requiresStartApproval": true,
"startApprovedAt": "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": {
"mode": "none"
},
"monitoringConfig": {
"datasourceId": "<string>",
"guardrailMetricIds": [
"<string>"
],
"exposureQuery": {
"id": "<string>",
"identifierType": "<string>"
},
"exposureQueryId": "<string>",
"signalMetricIds": [
"<string>"
],
"updateScheduleMinutes": 11,
"monitoringMode": "auto",
"autoUpdate": true,
"srmAction": "rollback",
"noTrafficAction": "rollback",
"noTrafficGracePeriodHours": 1,
"multipleExposureAction": "rollback"
},
"experimentHealthAction": "rollback",
"currentStepEnteredAt": "2023-11-07T05:31:56Z",
"stepApproval": {
"stepIndex": 123,
"approvedAt": "2023-11-07T05:31:56Z",
"approvedBy": "<string>",
"context": "ui",
"approvedByUser": {
"type": "dashboard",
"id": "<string>",
"apiKey": "<string>",
"name": "<string>",
"email": "<string>",
"requestedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"assumedRole": true
}
},
"monitoringStartDate": "2023-11-07T05:31:56Z",
"lastRollbackAt": "2023-11-07T05:31:56Z",
"lastRollbackReason": "<string>",
"monitoringStatus": {
"monitoringMode": "auto",
"autoUpdate": true,
"effectiveAutoUpdate": true,
"currentStepMonitored": true,
"safeRolloutId": "<string>",
"blockedReason": "<string>",
"nextSnapshotAt": "2023-11-07T05:31:56Z"
}
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}Authorizations
bearerAuthbasicAuth
If using Bearer auth, pass the Secret Key as the token:
curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456"
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
When true, the ramp holds at step -1 with its rule disabled (zero traffic) until a human approves the start via /actions/approve-step. Composes with startDate.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
rollback, hold, warn Response
Resource created
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X POST 'https://api.growthbook.io/api/v1/ramp-schedules' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/ramp-schedules"
payload = {
"name": "<string>",
"featureId": "<string>",
"ruleId": "<string>",
"environment": "<string>",
"steps": [
{
"interval": 1,
"actions": [],
"approvalNotes": "<string>",
"monitored": False,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": True
}
}
],
"startActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": True,
"environments": ["<string>"],
"force": "<unknown>",
"enabled": True,
"hashAttribute": "<string>",
"seed": "<string>",
"hashVersion": 1
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"endActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": True,
"environments": ["<string>"],
"force": "<unknown>",
"enabled": True
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"cutoffDate": "2023-11-07T05:31:56Z",
"requiresStartApproval": True,
"monitoringConfig": {
"datasourceId": "<string>",
"guardrailMetricIds": ["<string>"],
"exposureQueryId": "<string>",
"signalMetricIds": ["<string>"],
"autoUpdate": True,
"autoRollback": True,
"updateScheduleMinutes": 11
},
"templateId": "<string>"
}
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({
name: '<string>',
featureId: '<string>',
ruleId: '<string>',
environment: '<string>',
steps: [
{
interval: 1,
actions: [],
approvalNotes: '<string>',
monitored: false,
holdConditions: {minSampleSize: 123, requiresApproval: true}
}
],
startActions: [
{
patch: {
ruleId: '<string>',
coverage: 0.5,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
allEnvironments: true,
environments: ['<string>'],
force: '<unknown>',
enabled: true,
hashAttribute: '<string>',
seed: '<string>',
hashVersion: 1
},
targetType: 'feature-rule',
targetId: '<string>'
}
],
endActions: [
{
patch: {
ruleId: '<string>',
coverage: 0.5,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
allEnvironments: true,
environments: ['<string>'],
force: '<unknown>',
enabled: true
},
targetType: 'feature-rule',
targetId: '<string>'
}
],
startDate: '2023-11-07T05:31:56Z',
cutoffDate: '2023-11-07T05:31:56Z',
requiresStartApproval: true,
monitoringConfig: {
datasourceId: '<string>',
guardrailMetricIds: ['<string>'],
exposureQueryId: '<string>',
signalMetricIds: ['<string>'],
autoUpdate: true,
autoRollback: true,
updateScheduleMinutes: 11
},
templateId: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/ramp-schedules', 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",
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([
'name' => '<string>',
'featureId' => '<string>',
'ruleId' => '<string>',
'environment' => '<string>',
'steps' => [
[
'interval' => 1,
'actions' => [
],
'approvalNotes' => '<string>',
'monitored' => false,
'holdConditions' => [
'minSampleSize' => 123,
'requiresApproval' => true
]
]
],
'startActions' => [
[
'patch' => [
'ruleId' => '<string>',
'coverage' => 0.5,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'allEnvironments' => true,
'environments' => [
'<string>'
],
'force' => '<unknown>',
'enabled' => true,
'hashAttribute' => '<string>',
'seed' => '<string>',
'hashVersion' => 1
],
'targetType' => 'feature-rule',
'targetId' => '<string>'
]
],
'endActions' => [
[
'patch' => [
'ruleId' => '<string>',
'coverage' => 0.5,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'allEnvironments' => true,
'environments' => [
'<string>'
],
'force' => '<unknown>',
'enabled' => true
],
'targetType' => 'feature-rule',
'targetId' => '<string>'
]
],
'startDate' => '2023-11-07T05:31:56Z',
'cutoffDate' => '2023-11-07T05:31:56Z',
'requiresStartApproval' => true,
'monitoringConfig' => [
'datasourceId' => '<string>',
'guardrailMetricIds' => [
'<string>'
],
'exposureQueryId' => '<string>',
'signalMetricIds' => [
'<string>'
],
'autoUpdate' => true,
'autoRollback' => true,
'updateScheduleMinutes' => 11
],
'templateId' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"featureId\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"environment\": \"<string>\",\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [],\n \"approvalNotes\": \"<string>\",\n \"monitored\": false,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\n }\n ],\n \"startActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true,\n \"hashAttribute\": \"<string>\",\n \"seed\": \"<string>\",\n \"hashVersion\": 1\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"endActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"cutoffDate\": \"2023-11-07T05:31:56Z\",\n \"requiresStartApproval\": true,\n \"monitoringConfig\": {\n \"datasourceId\": \"<string>\",\n \"guardrailMetricIds\": [\n \"<string>\"\n ],\n \"exposureQueryId\": \"<string>\",\n \"signalMetricIds\": [\n \"<string>\"\n ],\n \"autoUpdate\": true,\n \"autoRollback\": true,\n \"updateScheduleMinutes\": 11\n },\n \"templateId\": \"<string>\"\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"featureId\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"environment\": \"<string>\",\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [],\n \"approvalNotes\": \"<string>\",\n \"monitored\": false,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\n }\n ],\n \"startActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true,\n \"hashAttribute\": \"<string>\",\n \"seed\": \"<string>\",\n \"hashVersion\": 1\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"endActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"cutoffDate\": \"2023-11-07T05:31:56Z\",\n \"requiresStartApproval\": true,\n \"monitoringConfig\": {\n \"datasourceId\": \"<string>\",\n \"guardrailMetricIds\": [\n \"<string>\"\n ],\n \"exposureQueryId\": \"<string>\",\n \"signalMetricIds\": [\n \"<string>\"\n ],\n \"autoUpdate\": true,\n \"autoRollback\": true,\n \"updateScheduleMinutes\": 11\n },\n \"templateId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/ramp-schedules")
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 \"name\": \"<string>\",\n \"featureId\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"environment\": \"<string>\",\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [],\n \"approvalNotes\": \"<string>\",\n \"monitored\": false,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\n }\n ],\n \"startActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true,\n \"hashAttribute\": \"<string>\",\n \"seed\": \"<string>\",\n \"hashVersion\": 1\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"endActions\": [\n {\n \"patch\": {\n \"ruleId\": \"<string>\",\n \"coverage\": 0.5,\n \"condition\": \"<string>\",\n \"savedGroups\": [\n {\n \"ids\": [\n \"<string>\"\n ]\n }\n ],\n \"prerequisites\": [\n {\n \"id\": \"<string>\",\n \"condition\": \"<string>\"\n }\n ],\n \"allEnvironments\": true,\n \"environments\": [\n \"<string>\"\n ],\n \"force\": \"<unknown>\",\n \"enabled\": true\n },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"cutoffDate\": \"2023-11-07T05:31:56Z\",\n \"requiresStartApproval\": true,\n \"monitoringConfig\": {\n \"datasourceId\": \"<string>\",\n \"guardrailMetricIds\": [\n \"<string>\"\n ],\n \"exposureQueryId\": \"<string>\",\n \"signalMetricIds\": [\n \"<string>\"\n ],\n \"autoUpdate\": true,\n \"autoRollback\": true,\n \"updateScheduleMinutes\": 11\n },\n \"templateId\": \"<string>\"\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>",
"status": "pending-join",
"ruleId": "<string>",
"environment": "<string>",
"activatingRevisionVersion": 123
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"targetType": "feature-rule",
"targetId": "<string>",
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
}
}
],
"approvalNotes": "<string>",
"monitored": true,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": true
}
}
],
"status": "pending",
"currentStepIndex": 0,
"nextStepAt": "2023-11-07T05:31:56Z",
"awaitingApproval": true,
"startActions": [
{
"targetType": "feature-rule",
"targetId": "<string>",
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true,
"hashAttribute": "<string>",
"seed": "<string>",
"hashVersion": 1
}
}
],
"endActions": [
{
"targetType": "feature-rule",
"targetId": "<string>",
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"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",
"requiresStartApproval": true,
"startApprovedAt": "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": {
"mode": "none"
},
"monitoringConfig": {
"datasourceId": "<string>",
"guardrailMetricIds": [
"<string>"
],
"exposureQuery": {
"id": "<string>",
"identifierType": "<string>"
},
"exposureQueryId": "<string>",
"signalMetricIds": [
"<string>"
],
"updateScheduleMinutes": 11,
"monitoringMode": "auto",
"autoUpdate": true,
"srmAction": "rollback",
"noTrafficAction": "rollback",
"noTrafficGracePeriodHours": 1,
"multipleExposureAction": "rollback"
},
"experimentHealthAction": "rollback",
"currentStepEnteredAt": "2023-11-07T05:31:56Z",
"stepApproval": {
"stepIndex": 123,
"approvedAt": "2023-11-07T05:31:56Z",
"approvedBy": "<string>",
"context": "ui",
"approvedByUser": {
"type": "dashboard",
"id": "<string>",
"apiKey": "<string>",
"name": "<string>",
"email": "<string>",
"requestedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"assumedRole": true
}
},
"monitoringStartDate": "2023-11-07T05:31:56Z",
"lastRollbackAt": "2023-11-07T05:31:56Z",
"lastRollbackReason": "<string>",
"monitoringStatus": {
"monitoringMode": "auto",
"autoUpdate": true,
"effectiveAutoUpdate": true,
"currentStepMonitored": true,
"safeRolloutId": "<string>",
"blockedReason": "<string>",
"nextSnapshotAt": "2023-11-07T05:31:56Z"
}
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}