Add a rule to a draft revision
deprecated
Deprecated. Use POST /v2/features/:id/revisions/:version/rules instead, which accepts rules with unified allEnvironments/environments scope fields instead of a per-environment environment parameter.
Appends a new rule to the end of the rule list for the given environment. A rule.type of force, rollout, experiment-ref, or safe-rollout determines the accepted shape. Use rampSchedule for ramp configuration or schedule for a simple start/end window; if both are provided, rampSchedule wins.
POST
/
v1
/
features
/
{id}
/
revisions
/
{version}
/
rules
cURL
curl -X POST 'https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules"
payload = {
"environment": "<string>",
"rule": {
"type": "experiment-ref",
"experimentId": "<string>",
"variations": [
{
"value": "<string>",
"variationId": "<string>"
}
],
"description": "<string>",
"enabled": True,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"scheduleRules": [
{
"timestamp": "<string>",
"enabled": True
}
],
"sparse": True
},
"rampSchedule": {
"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"
},
"schedule": {
"startDate": "<string>",
"endDate": "<string>"
},
"revisionTitle": "<string>",
"revisionComment": "<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({
environment: '<string>',
rule: {
type: 'experiment-ref',
experimentId: '<string>',
variations: [{value: '<string>', variationId: '<string>'}],
description: '<string>',
enabled: true,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
scheduleRules: [{timestamp: '<string>', enabled: true}],
sparse: true
},
rampSchedule: {
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'
},
schedule: {startDate: '<string>', endDate: '<string>'},
revisionTitle: '<string>',
revisionComment: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules', 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/features/{id}/revisions/{version}/rules",
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([
'environment' => '<string>',
'rule' => [
'type' => 'experiment-ref',
'experimentId' => '<string>',
'variations' => [
[
'value' => '<string>',
'variationId' => '<string>'
]
],
'description' => '<string>',
'enabled' => true,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'scheduleRules' => [
[
'timestamp' => '<string>',
'enabled' => true
]
],
'sparse' => true
],
'rampSchedule' => [
'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'
],
'schedule' => [
'startDate' => '<string>',
'endDate' => '<string>'
],
'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/v1/features/{id}/revisions/{version}/rules"
payload := strings.NewReader("{\n \"environment\": \"<string>\",\n \"rule\": {\n \"type\": \"experiment-ref\",\n \"experimentId\": \"<string>\",\n \"variations\": [\n {\n \"value\": \"<string>\",\n \"variationId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"enabled\": true,\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 \"scheduleRules\": [\n {\n \"timestamp\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"sparse\": true\n },\n \"rampSchedule\": {\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 },\n \"schedule\": {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<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/features/{id}/revisions/{version}/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"environment\": \"<string>\",\n \"rule\": {\n \"type\": \"experiment-ref\",\n \"experimentId\": \"<string>\",\n \"variations\": [\n {\n \"value\": \"<string>\",\n \"variationId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"enabled\": true,\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 \"scheduleRules\": [\n {\n \"timestamp\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"sparse\": true\n },\n \"rampSchedule\": {\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 },\n \"schedule\": {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules")
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 \"environment\": \"<string>\",\n \"rule\": {\n \"type\": \"experiment-ref\",\n \"experimentId\": \"<string>\",\n \"variations\": [\n {\n \"value\": \"<string>\",\n \"variationId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"enabled\": true,\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 \"scheduleRules\": [\n {\n \"timestamp\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"sparse\": true\n },\n \"rampSchedule\": {\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 },\n \"schedule\": {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\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": {},
"createdBy": "<string>",
"publishedBy": "<string>",
"defaultValue": "<string>",
"definitions": {},
"environmentsEnabled": {},
"envPrerequisites": {},
"prerequisites": [
{
"id": "<string>",
"condition": "<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": {}
}
]
}
}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
Response
200 - application/json
Resource created
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X POST 'https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules"
payload = {
"environment": "<string>",
"rule": {
"type": "experiment-ref",
"experimentId": "<string>",
"variations": [
{
"value": "<string>",
"variationId": "<string>"
}
],
"description": "<string>",
"enabled": True,
"condition": "<string>",
"savedGroups": [{ "ids": ["<string>"] }],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"scheduleRules": [
{
"timestamp": "<string>",
"enabled": True
}
],
"sparse": True
},
"rampSchedule": {
"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"
},
"schedule": {
"startDate": "<string>",
"endDate": "<string>"
},
"revisionTitle": "<string>",
"revisionComment": "<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({
environment: '<string>',
rule: {
type: 'experiment-ref',
experimentId: '<string>',
variations: [{value: '<string>', variationId: '<string>'}],
description: '<string>',
enabled: true,
condition: '<string>',
savedGroups: [{ids: ['<string>']}],
prerequisites: [{id: '<string>', condition: '<string>'}],
scheduleRules: [{timestamp: '<string>', enabled: true}],
sparse: true
},
rampSchedule: {
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'
},
schedule: {startDate: '<string>', endDate: '<string>'},
revisionTitle: '<string>',
revisionComment: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules', 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/features/{id}/revisions/{version}/rules",
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([
'environment' => '<string>',
'rule' => [
'type' => 'experiment-ref',
'experimentId' => '<string>',
'variations' => [
[
'value' => '<string>',
'variationId' => '<string>'
]
],
'description' => '<string>',
'enabled' => true,
'condition' => '<string>',
'savedGroups' => [
[
'ids' => [
'<string>'
]
]
],
'prerequisites' => [
[
'id' => '<string>',
'condition' => '<string>'
]
],
'scheduleRules' => [
[
'timestamp' => '<string>',
'enabled' => true
]
],
'sparse' => true
],
'rampSchedule' => [
'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'
],
'schedule' => [
'startDate' => '<string>',
'endDate' => '<string>'
],
'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/v1/features/{id}/revisions/{version}/rules"
payload := strings.NewReader("{\n \"environment\": \"<string>\",\n \"rule\": {\n \"type\": \"experiment-ref\",\n \"experimentId\": \"<string>\",\n \"variations\": [\n {\n \"value\": \"<string>\",\n \"variationId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"enabled\": true,\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 \"scheduleRules\": [\n {\n \"timestamp\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"sparse\": true\n },\n \"rampSchedule\": {\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 },\n \"schedule\": {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<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/features/{id}/revisions/{version}/rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"environment\": \"<string>\",\n \"rule\": {\n \"type\": \"experiment-ref\",\n \"experimentId\": \"<string>\",\n \"variations\": [\n {\n \"value\": \"<string>\",\n \"variationId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"enabled\": true,\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 \"scheduleRules\": [\n {\n \"timestamp\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"sparse\": true\n },\n \"rampSchedule\": {\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 },\n \"schedule\": {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\n },\n \"revisionTitle\": \"<string>\",\n \"revisionComment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/rules")
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 \"environment\": \"<string>\",\n \"rule\": {\n \"type\": \"experiment-ref\",\n \"experimentId\": \"<string>\",\n \"variations\": [\n {\n \"value\": \"<string>\",\n \"variationId\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"enabled\": true,\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 \"scheduleRules\": [\n {\n \"timestamp\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"sparse\": true\n },\n \"rampSchedule\": {\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 },\n \"schedule\": {\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\"\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": {},
"createdBy": "<string>",
"publishedBy": "<string>",
"defaultValue": "<string>",
"definitions": {},
"environmentsEnabled": {},
"envPrerequisites": {},
"prerequisites": [
{
"id": "<string>",
"condition": "<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": {}
}
]
}
}