Partially update a single config

POST

configs

{key}

cURL

curl -X POST 'https://api.growthbook.io/api/v1/configs/checkout-flow' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"value":{"timeout":60,"retries":3}}'

import requests

url = "https://api.growthbook.io/api/v1/configs/{key}"

payload = {
    "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>"
        }
    ],
    "bypassApproval": True,
    "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({
    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>'}],
    bypassApproval: true,
    ignoreWarnings: true,
    skipSchemaValidation: true,
    skipHooks: true
  })
};

fetch('https://api.growthbook.io/api/v1/configs/{key}', 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/{key}",
  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>',
    '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>'
        ]
    ],
    'bypassApproval' => true,
    '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/{key}"

	payload := strings.NewReader("{\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  \"bypassApproval\": true,\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/{key}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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  \"bypassApproval\": true,\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/{key}")

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  \"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  \"bypassApproval\": true,\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>"
  ],
  "bypassedGates": [
    {
      "type": "<string>",
      "outcome": "bypassed",
      "via": "ignoreWarnings"
    }
  ]
}

Authorizations

Authorization

string

header

required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1/features   -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

key

string

required

The key of the config

Query Parameters

skipSchemaValidation

deprecated

Deprecated — pass skipSchemaValidation in the request body instead.

Allowed value: "true"

ignoreWarnings

deprecated

Deprecated — pass ignoreWarnings in the request body instead.

Allowed value: "true"

Body

application/json

name

string

parent

string

Change the lineage parent (the key of the config to inherit from). Set to an empty string to detach from the parent and make this a root config.

extends

string[]

Replace the composition bases (mixins) layered on top of parent, in precedence order (later overrides earlier; all override parent; own keys win last). Send the complete set; an empty array clears all mixins. Set inheritance here, never via a @config: entry in value.

value

object

This config's base value as a JSON object. Per-environment/project variants are expressed via scopedOverrides.

Show child attributes

scopedOverrides

object[]

Replace the 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. Send the complete list; an empty array clears all overrides; omit to leave unchanged. Entries must reference existing configs, may not reference this config itself, and may not be unreachable.

Show child attributes

description

string

Maximum string length: 10000

project

string

owner

string

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.

schema

object

Replace this config's field definitions, as a JSON Schema document ({ type: "json-schema", value }) or typed-code source ({ type: "typescript" | "protobuf" | "python" | "go" | "rust", value }). Fields whose key a published ancestor already owns follow "base wins": an identical re-declaration is stripped with a redundant-declaration warning; one with a differing definition is rejected. A schema change cascades the 'base wins' normalization to descendants when published; a change that removes or retypes fields descendants still use soft-blocks with a 422 unless the request body sets ignoreWarnings: true. Conversion warnings are returned in warnings.

Show child attributes

source

string

Optional identifier of the consuming codebase/service. When a typescript or protobuf schema is supplied, its named-type structure is captured under this source for reproduction on export.

extensible

boolean

experimentGuard

boolean

Enable or disable the experiment guard for this Config. Disabling it requires Bypass draft approvals access.

invariants

object[]

Replace the config's cross-field validation rules. Each rule's expression is a mongo condition (mongrule). Send the complete set; an empty array clears all rules. Omit to leave them unchanged.

Show child attributes

bypassApproval

boolean

Set to true to write directly to the live Config without approval. The caller must have Bypass draft approvals access in the Config's Project, unless the organization enables the REST API approval bypass. This field has no effect when approval is not required.

ignoreWarnings

boolean

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.

skipSchemaValidation

boolean

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.

skipHooks

boolean

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.

Response

200 - application/json

Resource created

config

object

required

Show child attributes

warnings

object[]

Show child attributes

postPublishWarnings

string[]

Steps that failed AFTER the value publish committed (e.g. an experiment-guard toggle in the same request). The publish stands; retry only the named step.

bypassedGates

object[]

Gates that would have blocked this publish but were bypassed by the caller's authority. Present only when at least one gate was bypassed.

Show child attributes

cURL

curl -X POST 'https://api.growthbook.io/api/v1/configs/checkout-flow' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"value":{"timeout":60,"retries":3}}'

import requests

url = "https://api.growthbook.io/api/v1/configs/{key}"

payload = {
    "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>"
        }
    ],
    "bypassApproval": True,
    "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({
    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>'}],
    bypassApproval: true,
    ignoreWarnings: true,
    skipSchemaValidation: true,
    skipHooks: true
  })
};

fetch('https://api.growthbook.io/api/v1/configs/{key}', 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/{key}",
  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>',
    '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>'
        ]
    ],
    'bypassApproval' => true,
    '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/{key}"

	payload := strings.NewReader("{\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  \"bypassApproval\": true,\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/{key}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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  \"bypassApproval\": true,\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/{key}")

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  \"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  \"bypassApproval\": true,\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>"
  ],
  "bypassedGates": [
    {
      "type": "<string>",
      "outcome": "bypassed",
      "via": "ignoreWarnings"
    }
  ]
}

Introduction

Endpoints

Models

Authorizations

Path Parameters

Query Parameters

Body

Response