Set ramp schedule for a rule
Queues a revision-controlled ramp action for this rule. If the rule already has a live ramp schedule, this stores an update action applied on publish; otherwise it stores a create action. No live schedule config changes are applied immediately by this endpoint.
You can build the ramp from a template (templateId) and set the rollback anchor (startState) in the same request — e.g. pull in a template and pass startState: { "coverage": 0 } so a rollback returns the rule to 0%.
PUT
/
v2
/
features
/
{id}
/
revisions
/
{version}
/
rules
/
{ruleId}
/
ramp-schedule
cURL
curl -X PUT 'https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule"
payload = {
"name": "<string>",
"templateId": "<string>",
"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
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"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>"
}
],
"approvalNotes": "<string>",
"monitored": True,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": True
}
}
],
"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",
"environment": "<string>",
"startState": {
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": True,
"environments": ["<string>"],
"force": "<unknown>",
"enabled": True
},
"revisionTitle": "<string>",
"revisionComment": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
templateId: '<string>',
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
},
targetType: 'feature-rule',
targetId: '<string>'
}
],
steps: [
{
interval: 1,
actions: [
{
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>'
}
],
approvalNotes: '<string>',
monitored: true,
holdConditions: {minSampleSize: 123, requiresApproval: true}
}
],
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',
environment: '<string>',
startState: {
coverage: 0.5,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
allEnvironments: true,
environments: ['<string>'],
force: '<unknown>',
enabled: true
},
revisionTitle: '<string>',
revisionComment: '<string>'
})
};
fetch('https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule', 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/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'templateId' => '<string>',
'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
],
'targetType' => 'feature-rule',
'targetId' => '<string>'
]
],
'steps' => [
[
'interval' => 1,
'actions' => [
[
'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>'
]
],
'approvalNotes' => '<string>',
'monitored' => true,
'holdConditions' => [
'minSampleSize' => 123,
'requiresApproval' => true
]
]
],
'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',
'environment' => '<string>',
'startState' => [
'coverage' => 0.5,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'allEnvironments' => true,
'environments' => [
'<string>'
],
'force' => '<unknown>',
'enabled' => true
],
'revisionTitle' => '<string>',
'revisionComment' => '<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/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"templateId\": \"<string>\",\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 },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [\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 \"approvalNotes\": \"<string>\",\n \"monitored\": true,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\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 \"environment\": \"<string>\",\n \"startState\": {\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 \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"templateId\": \"<string>\",\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 },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [\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 \"approvalNotes\": \"<string>\",\n \"monitored\": true,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\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 \"environment\": \"<string>\",\n \"startState\": {\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 \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"templateId\": \"<string>\",\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 },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [\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 \"approvalNotes\": \"<string>\",\n \"monitored\": true,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\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 \"environment\": \"<string>\",\n \"startState\": {\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 \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"revision": {
"featureId": "<string>",
"baseVersion": 123,
"version": 123,
"comment": "<string>",
"date": "2023-11-07T05:31:56Z",
"status": "<string>",
"rules": [
{
"description": "<string>",
"id": "<string>",
"enabled": true,
"type": "force",
"value": "<string>",
"allEnvironments": true,
"condition": "<string>",
"scheduleRules": [
{
"enabled": true,
"timestamp": "2023-11-07T05:31:56Z"
}
],
"rampScheduleId": "<string>",
"savedGroupTargeting": [
{
"savedGroups": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"sparse": true,
"environments": [
"<string>"
]
}
],
"createdBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"publishedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"defaultValue": "<string>",
"definitions": {},
"environmentsEnabled": {},
"envPrerequisites": {},
"prerequisites": [
{
"id": "<string>"
}
],
"metadata": {
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"tags": [
"<string>"
],
"neverStale": true,
"valueType": "<string>",
"jsonSchema": {
"schema": "<string>",
"simple": {},
"date": "2023-11-07T05:31:56Z",
"enabled": true
},
"customFields": {}
},
"rampActions": [
{
"mode": "create",
"ruleId": "<string>",
"name": "<string>",
"environment": "<string>",
"templateId": "<string>",
"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
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"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>"
}
],
"approvalNotes": "<string>",
"monitored": true,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": true
}
}
],
"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",
"monitoringConfig": {
"datasourceId": "<string>",
"exposureQueryId": "<string>",
"guardrailMetricIds": [
"<string>"
],
"signalMetricIds": [
"<string>"
],
"updateScheduleMinutes": 11,
"autoUpdate": true,
"noTrafficGracePeriodHours": 1
},
"lockdownConfig": {}
}
],
"autoPublishOnApproval": true,
"scheduledPublishAt": "2023-11-07T05:31:56Z",
"scheduledPublishLockEdits": true,
"scheduledPublishLockOthers": true,
"scheduledPublishBypassApproval": true,
"scheduledPublishLastError": "<string>",
"reviews": [
{
"userId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
}
}
]
},
"warnings": [
"<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
ISO 8601 date-time, e.g. "2025-06-01T00:00:00Z". Absent or null means start immediately on publish.
ISO 8601 date-time, e.g. "2025-07-01T00:00:00Z". The ramp ends at this time.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The rule state to roll back to (the rollback/jump-to-start anchor). Merged onto the rule's current state, so { "coverage": 0 } keeps existing targeting but rolls back to 0%. This affects rollbacks only — it is NOT applied when the ramp starts. On create, omitting it infers the anchor from the rule's current coverage (and returns a warning if that isn't 0%); on update of a live schedule, omitting it leaves the existing anchor unchanged.
Show child attributes
Show child attributes
Title for a newly created draft. Only used when version is "new"; ignored for existing revisions.
Comment for a newly created draft. Only used when version is "new"; ignored for existing revisions.
Was this page helpful?
⌘I
cURL
curl -X PUT 'https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule"
payload = {
"name": "<string>",
"templateId": "<string>",
"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
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"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>"
}
],
"approvalNotes": "<string>",
"monitored": True,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": True
}
}
],
"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",
"environment": "<string>",
"startState": {
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": True,
"environments": ["<string>"],
"force": "<unknown>",
"enabled": True
},
"revisionTitle": "<string>",
"revisionComment": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
templateId: '<string>',
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
},
targetType: 'feature-rule',
targetId: '<string>'
}
],
steps: [
{
interval: 1,
actions: [
{
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>'
}
],
approvalNotes: '<string>',
monitored: true,
holdConditions: {minSampleSize: 123, requiresApproval: true}
}
],
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',
environment: '<string>',
startState: {
coverage: 0.5,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
allEnvironments: true,
environments: ['<string>'],
force: '<unknown>',
enabled: true
},
revisionTitle: '<string>',
revisionComment: '<string>'
})
};
fetch('https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule', 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/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'templateId' => '<string>',
'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
],
'targetType' => 'feature-rule',
'targetId' => '<string>'
]
],
'steps' => [
[
'interval' => 1,
'actions' => [
[
'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>'
]
],
'approvalNotes' => '<string>',
'monitored' => true,
'holdConditions' => [
'minSampleSize' => 123,
'requiresApproval' => true
]
]
],
'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',
'environment' => '<string>',
'startState' => [
'coverage' => 0.5,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'allEnvironments' => true,
'environments' => [
'<string>'
],
'force' => '<unknown>',
'enabled' => true
],
'revisionTitle' => '<string>',
'revisionComment' => '<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/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"templateId\": \"<string>\",\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 },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [\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 \"approvalNotes\": \"<string>\",\n \"monitored\": true,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\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 \"environment\": \"<string>\",\n \"startState\": {\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 \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"templateId\": \"<string>\",\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 },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [\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 \"approvalNotes\": \"<string>\",\n \"monitored\": true,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\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 \"environment\": \"<string>\",\n \"startState\": {\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 \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v2/features/{id}/revisions/{version}/rules/{ruleId}/ramp-schedule")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"templateId\": \"<string>\",\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 },\n \"targetType\": \"feature-rule\",\n \"targetId\": \"<string>\"\n }\n ],\n \"steps\": [\n {\n \"interval\": 1,\n \"actions\": [\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 \"approvalNotes\": \"<string>\",\n \"monitored\": true,\n \"holdConditions\": {\n \"minSampleSize\": 123,\n \"requiresApproval\": true\n }\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 \"environment\": \"<string>\",\n \"startState\": {\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 \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"revision": {
"featureId": "<string>",
"baseVersion": 123,
"version": 123,
"comment": "<string>",
"date": "2023-11-07T05:31:56Z",
"status": "<string>",
"rules": [
{
"description": "<string>",
"id": "<string>",
"enabled": true,
"type": "force",
"value": "<string>",
"allEnvironments": true,
"condition": "<string>",
"scheduleRules": [
{
"enabled": true,
"timestamp": "2023-11-07T05:31:56Z"
}
],
"rampScheduleId": "<string>",
"savedGroupTargeting": [
{
"savedGroups": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"sparse": true,
"environments": [
"<string>"
]
}
],
"createdBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"publishedBy": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
},
"defaultValue": "<string>",
"definitions": {},
"environmentsEnabled": {},
"envPrerequisites": {},
"prerequisites": [
{
"id": "<string>"
}
],
"metadata": {
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"tags": [
"<string>"
],
"neverStale": true,
"valueType": "<string>",
"jsonSchema": {
"schema": "<string>",
"simple": {},
"date": "2023-11-07T05:31:56Z",
"enabled": true
},
"customFields": {}
},
"rampActions": [
{
"mode": "create",
"ruleId": "<string>",
"name": "<string>",
"environment": "<string>",
"templateId": "<string>",
"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
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"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>"
}
],
"approvalNotes": "<string>",
"monitored": true,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": true
}
}
],
"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",
"monitoringConfig": {
"datasourceId": "<string>",
"exposureQueryId": "<string>",
"guardrailMetricIds": [
"<string>"
],
"signalMetricIds": [
"<string>"
],
"updateScheduleMinutes": 11,
"autoUpdate": true,
"noTrafficGracePeriodHours": 1
},
"lockdownConfig": {}
}
],
"autoPublishOnApproval": true,
"scheduledPublishAt": "2023-11-07T05:31:56Z",
"scheduledPublishLockEdits": true,
"scheduledPublishLockOthers": true,
"scheduledPublishBypassApproval": true,
"scheduledPublishLastError": "<string>",
"reviews": [
{
"userId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"user": {
"id": "<string>",
"name": "<string>",
"email": "<string>"
}
}
]
},
"warnings": [
"<string>"
]
}