Remote Config

GET/api/v1/config

List_configs

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

q?string

Full-text search over this list's searchable fields.

Length1 <= length <= 200

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: updated_at, created_at. Default: -created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

prefix?string

Only configs whose key starts with this prefix

environment?string

Only configs with a value in this environment, whose value include_values then returns

include_values?boolean

Include values in response

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config"

{  "configs": [    {      "description": "string",      "environments": [        "string"      ],      "key": "string",      "type": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": null,      "version": 0    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

POST/api/v1/config

Create_config

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description*string

key*string

metadata?unknown

schema*unknown

tags?array<string>

value*unknown

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/config" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "key": "string",    "schema": null,    "value": null  }'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "id": "string",  "key": "string",  "metadata": null,  "schema": null,  "tags": [    "string"  ],  "updated_at": "2019-08-24T14:15:22Z",  "value": null,  "version": 0}

POST/api/v1/config/bulk-get

Bulk_get_configs

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

environment?string|null

include_defaults?boolean

keys*array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/config/bulk-get" \  -H "Content-Type: application/json" \  -d '{    "keys": [      "string"    ]  }'

{  "cache_ttl_seconds": 0,  "configs": {    "property1": {      "source": "default",      "value": null,      "version": 0    },    "property2": {      "source": "default",      "value": null,      "version": 0    }  },  "missing_keys": [    "string"  ]}

GET/api/v1/config/environments

List_environments

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

filter?

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: created_at. Default: created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/environments"

{  "environments": [    {      "created_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "description": "string",      "inherits_from": "string",      "name": "string",      "protected": true    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

POST/api/v1/config/environments

Create_environment

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description*string

inherits_from?string|null

name*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/config/environments" \  -H "Content-Type: application/json" \  -d '{    "description": "string",    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "created_by": "string",  "description": "string",  "inherits_from": "string",  "name": "string",  "protected": true}

DELETE/api/v1/config/environments/{name}

Delete_environment

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

name*string

Environment name

Response Body

curl -X DELETE "https://example.com/api/v1/config/environments/string"

Empty

POST/api/v1/config/evaluate-batch

Evaluate_batch

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to evaluate multiple flags at once

context*

Evaluation context with user_id and attributes

environment?|

Environment to evaluate in (defaults to "base")

keys*array<string>

Config keys to evaluate

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/config/evaluate-batch" \  -H "Content-Type: application/json" \  -d '{    "context": {      "user_id": "string",      "property1": null,      "property2": null    },    "keys": [      "string"    ]  }'

{  "evaluation_time_ms": 0,  "evaluations": {    "property1": {      "enabled": true,      "reason": "default_enabled",      "rule_id": "string",      "variant": null    },    "property2": {      "enabled": true,      "reason": "default_enabled",      "rule_id": "string",      "variant": null    }  }}

POST/api/v1/config/validate

Validate_configs

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

configs*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/config/validate" \  -H "Content-Type: application/json" \  -d '{    "configs": [      {        "key": "string",        "value": null      }    ]  }'

{  "results": {    "property1": {      "errors": [        "string"      ],      "valid": true    },    "property2": {      "errors": [        "string"      ],      "valid": true    }  },  "valid": true}

GET/api/v1/config/{key}

Get_config

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

environment?string

Environment name (defaults to 'base')

include_metadata?boolean

Include full metadata

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/string"

{  "cache_ttl_seconds": 0,  "environment": "string",  "key": "string",  "metadata": null,  "source": "default",  "type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value": null,  "version": 0}

DELETE/api/v1/config/{key}

Delete_config

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

force?boolean

Force deletion

Response Body

curl -X DELETE "https://example.com/api/v1/config/string"

Empty

PUT/api/v1/config/{key}

Update_config

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string|null

environment?string|null

metadata?unknown

reason?string|null

validate_only?boolean

value*unknown

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/config/string" \  -H "Content-Type: application/json" \  -d '{    "value": null  }'

{  "cache_ttl_seconds": 0,  "environment": "string",  "key": "string",  "metadata": null,  "source": "default",  "type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value": null,  "version": 0}

GET/api/v1/config/{key}/analytics

Get_flag_analytics

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

environment?string

Environment to read analytics for (defaults to 'base')

window?string

Day window in YYYY-MM-DD form (defaults to today)

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/string/analytics"

{  "disabled_count": 0,  "enabled_count": 0,  "key": "string",  "reasons": {    "property1": 0,    "property2": 0  },  "total_evaluations": 0,  "unique_users": 0,  "window": "string"}

GET/api/v1/config/{key}/evaluate

Evaluate_flag

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

user_id*string

User ID for evaluation

environment?string

Environment (defaults to 'base')

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/string/evaluate?user_id=string"

{  "enabled": true,  "environment": "string",  "key": "string",  "reason": "default_enabled",  "rule_id": "string",  "variant": null}

GET/api/v1/config/{key}/history

Get_config_history

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

filter?

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: changed_at. Default: -changed_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/string/history"

{  "history": [    {      "changed_at": "2019-08-24T14:15:22Z",      "changed_by": "string",      "environment": "string",      "key": "string",      "previous_value": null,      "reason": "string",      "value": null,      "version": 0    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

POST/api/v1/config/{key}/rollback

Rollback_config

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

environment?string|null

reason*string

version*integer

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/config/string/rollback" \  -H "Content-Type: application/json" \  -d '{    "reason": "string",    "version": 0  }'

{  "cache_ttl_seconds": 0,  "environment": "string",  "key": "string",  "metadata": null,  "source": "default",  "type": "string",  "updated_at": "2019-08-24T14:15:22Z",  "value": null,  "version": 0}

GET/api/v1/config/{key}/rules

Get_rules

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

environment?string

Environment to read env-scoped rules from (falls back to global)

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/string/rules"

{  "default_enabled": true,  "default_variant": "string",  "environment": "string",  "key": "string",  "rules": [    {      "description": "string",      "id": "string",      "sticky": true,      "type": "percentage",      "value": 0,      "variant": null    }  ],  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/config/{key}/rules

Delete_rules

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Query Parameters

environment?string

Environment to delete env-scoped rules from (omit for global)

Response Body

curl -X DELETE "https://example.com/api/v1/config/string/rules"

Empty

PUT/api/v1/config/{key}/rules

Set_rules

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to set rules on a config (making it a feature flag)

default_enabled?boolean

Default result when no rules match

default_variant?|

Optional A/B variant returned when no rule matches and default is enabled

environment?|

Environment to scope these rules to. Omit to set the global (base) rules.

rules*array<|||>

Rules to evaluate in priority order

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/config/string/rules" \  -H "Content-Type: application/json" \  -d '{    "rules": [      {        "type": "percentage",        "value": 0      }    ]  }'

{  "default_enabled": true,  "default_variant": "string",  "environment": "string",  "key": "string",  "rules": [    {      "description": "string",      "id": "string",      "sticky": true,      "type": "percentage",      "value": 0,      "variant": null    }  ],  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/config/{key}/schema

Get_config_schema

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

key*string

Configuration key

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/config/string/schema"

{  "examples": [    null  ],  "key": "string",  "schema": null,  "type": "string"}

Remote Config

200application/json

400

401

503

201application/json

400

401

403

409

503

200application/json

400

401

503

200application/json

400

401

503

201application/json

400

401

403

409

503

204

401

403

404

409

503

200application/json

400

401

503

200application/json

400

401

503

200application/json

401

404

503

204

401

403

404

503

200application/json

400

401

403

404

503

200application/json

401

403

404

503

200application/json

400

401

503

200application/json

400

401

403

404

503

200application/json

400

401

403

404

503

200application/json

401

404

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`