Archive a single config

Archives a config. A child config (including an environment/project override) is archived outright when its live value is an empty patch or nothing serves it. When archiving would strip a value that live features or other configs still consume, the request returns a 422 listing the blocking gates — re-submit with "ignoreWarnings": true in the request body to acknowledge and proceed. A locked config, or one whose org requires approval, returns its own gate (unlock or route the change through a draft revision).

POST

configs

{key}

archive

cURL

curl -X POST 'https://api.growthbook.io/api/v1/configs/checkout-flow/archive' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

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

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

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

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

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  \"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"
  },
  "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

ignoreWarnings

deprecated

Deprecated — pass ignoreWarnings in the request body instead.

Allowed value: "true"

Body

application/json

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

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/archive' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

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

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

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

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

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

Introduction

Endpoints

Models

Archive a single config

Authorizations

Path Parameters

Query Parameters

Body

Response