Create a single config
POST
/
v1
/
configs
cURL
curl -X POST 'https://api.growthbook.io/api/v1/configs' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"key":"checkout-flow","name":"Checkout Flow","value":{"timeout":30,"retries":3}}'import requests
url = "https://api.growthbook.io/api/v1/configs"
payload = {
"key": "<string>",
"name": "<string>",
"parent": "<string>",
"extends": ["<string>"],
"value": {},
"scopedOverrides": [
{
"config": "<string>",
"environments": ["<string>"],
"projects": ["<string>"]
}
],
"description": "<string>",
"project": "<string>",
"owner": "<string>",
"schema": {
"type": "json-schema",
"value": {}
},
"source": "<string>",
"extensible": True,
"experimentGuard": True,
"invariants": [
{
"name": "<string>",
"rule": {},
"message": "<string>"
}
],
"ignoreWarnings": True,
"skipSchemaValidation": True,
"skipHooks": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
name: '<string>',
parent: '<string>',
extends: ['<string>'],
value: {},
scopedOverrides: [{config: '<string>', environments: ['<string>'], projects: ['<string>']}],
description: '<string>',
project: '<string>',
owner: '<string>',
schema: {type: 'json-schema', value: {}},
source: '<string>',
extensible: true,
experimentGuard: true,
invariants: [{name: '<string>', rule: {}, message: '<string>'}],
ignoreWarnings: true,
skipSchemaValidation: true,
skipHooks: true
})
};
fetch('https://api.growthbook.io/api/v1/configs', 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/configs",
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([
'key' => '<string>',
'name' => '<string>',
'parent' => '<string>',
'extends' => [
'<string>'
],
'value' => [
],
'scopedOverrides' => [
[
'config' => '<string>',
'environments' => [
'<string>'
],
'projects' => [
'<string>'
]
]
],
'description' => '<string>',
'project' => '<string>',
'owner' => '<string>',
'schema' => [
'type' => 'json-schema',
'value' => [
]
],
'source' => '<string>',
'extensible' => true,
'experimentGuard' => true,
'invariants' => [
[
'name' => '<string>',
'rule' => [
],
'message' => '<string>'
]
],
'ignoreWarnings' => true,
'skipSchemaValidation' => true,
'skipHooks' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/configs"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"parent\": \"<string>\",\n \"extends\": [\n \"<string>\"\n ],\n \"value\": {},\n \"scopedOverrides\": [\n {\n \"config\": \"<string>\",\n \"environments\": [\n \"<string>\"\n ],\n \"projects\": [\n \"<string>\"\n ]\n }\n ],\n \"description\": \"<string>\",\n \"project\": \"<string>\",\n \"owner\": \"<string>\",\n \"schema\": {\n \"type\": \"json-schema\",\n \"value\": {}\n },\n \"source\": \"<string>\",\n \"extensible\": true,\n \"experimentGuard\": true,\n \"invariants\": [\n {\n \"name\": \"<string>\",\n \"rule\": {},\n \"message\": \"<string>\"\n }\n ],\n \"ignoreWarnings\": true,\n \"skipSchemaValidation\": true,\n \"skipHooks\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/configs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"parent\": \"<string>\",\n \"extends\": [\n \"<string>\"\n ],\n \"value\": {},\n \"scopedOverrides\": [\n {\n \"config\": \"<string>\",\n \"environments\": [\n \"<string>\"\n ],\n \"projects\": [\n \"<string>\"\n ]\n }\n ],\n \"description\": \"<string>\",\n \"project\": \"<string>\",\n \"owner\": \"<string>\",\n \"schema\": {\n \"type\": \"json-schema\",\n \"value\": {}\n },\n \"source\": \"<string>\",\n \"extensible\": true,\n \"experimentGuard\": true,\n \"invariants\": [\n {\n \"name\": \"<string>\",\n \"rule\": {},\n \"message\": \"<string>\"\n }\n ],\n \"ignoreWarnings\": true,\n \"skipSchemaValidation\": true,\n \"skipHooks\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/configs")
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 \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"parent\": \"<string>\",\n \"extends\": [\n \"<string>\"\n ],\n \"value\": {},\n \"scopedOverrides\": [\n {\n \"config\": \"<string>\",\n \"environments\": [\n \"<string>\"\n ],\n \"projects\": [\n \"<string>\"\n ]\n }\n ],\n \"description\": \"<string>\",\n \"project\": \"<string>\",\n \"owner\": \"<string>\",\n \"schema\": {\n \"type\": \"json-schema\",\n \"value\": {}\n },\n \"source\": \"<string>\",\n \"extensible\": true,\n \"experimentGuard\": true,\n \"invariants\": [\n {\n \"name\": \"<string>\",\n \"rule\": {},\n \"message\": \"<string>\"\n }\n ],\n \"ignoreWarnings\": true,\n \"skipSchemaValidation\": true,\n \"skipHooks\": true\n}"
response = http.request(request)
puts response.read_body{
"config": {
"id": "<string>",
"key": "<string>",
"name": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"owner": "<string>",
"ownerEmail": "<string>",
"parent": "<string>",
"extends": [
"<string>"
],
"value": {},
"scopedOverrides": [
{
"config": "<string>",
"environments": [
"<string>"
],
"projects": [
"<string>"
]
}
],
"scopedConfig": {
"parent": "<string>",
"environments": [
"<string>"
],
"projects": [
"<string>"
]
},
"description": "<string>",
"project": "<string>",
"archived": true,
"schema": {
"type": "json-schema",
"value": {}
},
"extensible": true,
"invariants": [
{
"name": "<string>",
"rule": {},
"message": "<string>"
}
],
"locked": true,
"experimentGuard": true,
"lockedRevision": {
"id": "<string>",
"version": 123
},
"lockedBy": "<string>",
"dateLocked": "2023-11-07T05:31:56Z"
},
"warnings": [
{
"code": "dropped-declaration",
"message": "<string>",
"path": "<string>"
}
],
"postPublishWarnings": [
"<string>"
]
}{
"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
Query Parameters
Body
application/json
Ordered, first-match-wins environment/project-scoped variant selection. Each entry points at a flavor config (a child config, by key) whose value is deep-merged onto this config's resolved value when the (environment, project) scope matches — resolved at build time, per layer. This is how you create an environment-scoped override (as opposed to a plain child config): make a child config for the override value, then add it here with its scope. Send the complete list to replace it; an empty array clears all overrides. Entries must reference existing configs, may not reference this config itself, and may not be unreachable (fully subsumed by an earlier entry).
Show child attributes
Show child attributes
The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization. When omitted, it defaults to the requesting member: a personal access token's owner, or the member an organization API key assumes. An organization API key acting as itself leaves it empty.
Field definitions for this config, as a JSON Schema document ({ type: "json-schema", value }) or typed-code source ({ type: "typescript" | "protobuf" | "python" | "go" | "rust", value }) — converted server-side in one call. Fields whose key an ancestor (via parent/extends) already owns follow "base wins": an identical re-declaration is stripped with a redundant-declaration warning; one with a differing definition is rejected. A field owned by two sibling bases is a conflict and is rejected. Omit to leave the config schema-less. Conversion warnings are returned in warnings.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Set to true to acknowledge the warnings listed in a blocked response and continue. This covers experiment guards, locked dependents, and references affected by an archive. When the organization treats schema failures as warnings, it also covers schema and invariant warnings. It never bypasses a rejected Custom Hook. On revision publish endpoints, it can also force-publish an out-of-date draft when the caller has Bypass draft approvals access. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Set to true to publish despite schema validation errors, failed invariants, or schema changes that invalidate dependent resources. This does not bypass a rejected Custom Hook; use skipHooks for that. The caller must have Bypass draft approvals access for Feature Flags, Configs, and Constants in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Set to true to publish despite a Custom Hook rejection. This does not bypass schema validation; use skipSchemaValidation for that. The caller must have Bypass draft approvals access for Feature Flags, Configs, and Constants in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Was this page helpful?
⌘I
cURL
curl -X POST 'https://api.growthbook.io/api/v1/configs' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"key":"checkout-flow","name":"Checkout Flow","value":{"timeout":30,"retries":3}}'import requests
url = "https://api.growthbook.io/api/v1/configs"
payload = {
"key": "<string>",
"name": "<string>",
"parent": "<string>",
"extends": ["<string>"],
"value": {},
"scopedOverrides": [
{
"config": "<string>",
"environments": ["<string>"],
"projects": ["<string>"]
}
],
"description": "<string>",
"project": "<string>",
"owner": "<string>",
"schema": {
"type": "json-schema",
"value": {}
},
"source": "<string>",
"extensible": True,
"experimentGuard": True,
"invariants": [
{
"name": "<string>",
"rule": {},
"message": "<string>"
}
],
"ignoreWarnings": True,
"skipSchemaValidation": True,
"skipHooks": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
name: '<string>',
parent: '<string>',
extends: ['<string>'],
value: {},
scopedOverrides: [{config: '<string>', environments: ['<string>'], projects: ['<string>']}],
description: '<string>',
project: '<string>',
owner: '<string>',
schema: {type: 'json-schema', value: {}},
source: '<string>',
extensible: true,
experimentGuard: true,
invariants: [{name: '<string>', rule: {}, message: '<string>'}],
ignoreWarnings: true,
skipSchemaValidation: true,
skipHooks: true
})
};
fetch('https://api.growthbook.io/api/v1/configs', 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/configs",
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([
'key' => '<string>',
'name' => '<string>',
'parent' => '<string>',
'extends' => [
'<string>'
],
'value' => [
],
'scopedOverrides' => [
[
'config' => '<string>',
'environments' => [
'<string>'
],
'projects' => [
'<string>'
]
]
],
'description' => '<string>',
'project' => '<string>',
'owner' => '<string>',
'schema' => [
'type' => 'json-schema',
'value' => [
]
],
'source' => '<string>',
'extensible' => true,
'experimentGuard' => true,
'invariants' => [
[
'name' => '<string>',
'rule' => [
],
'message' => '<string>'
]
],
'ignoreWarnings' => true,
'skipSchemaValidation' => true,
'skipHooks' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.growthbook.io/api/v1/configs"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"parent\": \"<string>\",\n \"extends\": [\n \"<string>\"\n ],\n \"value\": {},\n \"scopedOverrides\": [\n {\n \"config\": \"<string>\",\n \"environments\": [\n \"<string>\"\n ],\n \"projects\": [\n \"<string>\"\n ]\n }\n ],\n \"description\": \"<string>\",\n \"project\": \"<string>\",\n \"owner\": \"<string>\",\n \"schema\": {\n \"type\": \"json-schema\",\n \"value\": {}\n },\n \"source\": \"<string>\",\n \"extensible\": true,\n \"experimentGuard\": true,\n \"invariants\": [\n {\n \"name\": \"<string>\",\n \"rule\": {},\n \"message\": \"<string>\"\n }\n ],\n \"ignoreWarnings\": true,\n \"skipSchemaValidation\": true,\n \"skipHooks\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/configs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"parent\": \"<string>\",\n \"extends\": [\n \"<string>\"\n ],\n \"value\": {},\n \"scopedOverrides\": [\n {\n \"config\": \"<string>\",\n \"environments\": [\n \"<string>\"\n ],\n \"projects\": [\n \"<string>\"\n ]\n }\n ],\n \"description\": \"<string>\",\n \"project\": \"<string>\",\n \"owner\": \"<string>\",\n \"schema\": {\n \"type\": \"json-schema\",\n \"value\": {}\n },\n \"source\": \"<string>\",\n \"extensible\": true,\n \"experimentGuard\": true,\n \"invariants\": [\n {\n \"name\": \"<string>\",\n \"rule\": {},\n \"message\": \"<string>\"\n }\n ],\n \"ignoreWarnings\": true,\n \"skipSchemaValidation\": true,\n \"skipHooks\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/configs")
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 \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"parent\": \"<string>\",\n \"extends\": [\n \"<string>\"\n ],\n \"value\": {},\n \"scopedOverrides\": [\n {\n \"config\": \"<string>\",\n \"environments\": [\n \"<string>\"\n ],\n \"projects\": [\n \"<string>\"\n ]\n }\n ],\n \"description\": \"<string>\",\n \"project\": \"<string>\",\n \"owner\": \"<string>\",\n \"schema\": {\n \"type\": \"json-schema\",\n \"value\": {}\n },\n \"source\": \"<string>\",\n \"extensible\": true,\n \"experimentGuard\": true,\n \"invariants\": [\n {\n \"name\": \"<string>\",\n \"rule\": {},\n \"message\": \"<string>\"\n }\n ],\n \"ignoreWarnings\": true,\n \"skipSchemaValidation\": true,\n \"skipHooks\": true\n}"
response = http.request(request)
puts response.read_body{
"config": {
"id": "<string>",
"key": "<string>",
"name": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"owner": "<string>",
"ownerEmail": "<string>",
"parent": "<string>",
"extends": [
"<string>"
],
"value": {},
"scopedOverrides": [
{
"config": "<string>",
"environments": [
"<string>"
],
"projects": [
"<string>"
]
}
],
"scopedConfig": {
"parent": "<string>",
"environments": [
"<string>"
],
"projects": [
"<string>"
]
},
"description": "<string>",
"project": "<string>",
"archived": true,
"schema": {
"type": "json-schema",
"value": {}
},
"extensible": true,
"invariants": [
{
"name": "<string>",
"rule": {},
"message": "<string>"
}
],
"locked": true,
"experimentGuard": true,
"lockedRevision": {
"id": "<string>",
"version": 123
},
"lockedBy": "<string>",
"dateLocked": "2023-11-07T05:31:56Z"
},
"warnings": [
{
"code": "dropped-declaration",
"message": "<string>",
"path": "<string>"
}
],
"postPublishWarnings": [
"<string>"
]
}{
"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>"
}