Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Config flags
A ConfigFlag is one typed configuration value or feature flag of an environment: a default, targeting rules, and percentage rollouts.
A ConfigFlag is one typed configuration value or feature flag of an environment: a default, targeting rules, and percentage rollouts.
Service Sylphx Config · Resource type config.sylphx.com/ConfigFlag · Name pattern orgs/{org}/projects/{project}/envs/{env}/config_flags/{config_flag} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/config_flags/{config_flag}; the id is the key evaluators ask for. |
uid | string | cfg_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ConfigFlagSpec | Desired state. Required. |
status | ConfigFlagStatus | Observed state. Output only. |
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a config flag. |
GET | list | Lists config flags in an environment. |
POST | create | Creates a config flag; the Operation is done when every cell serves it. |
PATCH | update | Updates a config flag; the change rolls out in waves and the Operation is done when every cell serves it. |
DELETE | delete | Deletes a config flag; evaluators then get their compiled-in fallback. |
POST | evaluate | Evaluates config flags of an environment for one evaluation context: each flag's value, and why. Browsers and mobile apps call it with a publishable key holding config:evaluate, which reads values, never rules. |
GET | snapshot | The environment's flags and segments in one read, for SDKs that evaluate locally. Poll it with if_none_match set to the last etag: an unchanged ruleset answers not_modified and nothing else. |
#get
Gets a config flag.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags/config-flag · scope config:read · effect read · Request, response and examples
#list
Lists config flags in an environment.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags · scope config:read · effect read · paginated · Request, response and examples
#create
Creates a config flag; the Operation is done when every cell serves it.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags · scope config:write · effect write · long-running · Request, response and examples
#update
Updates a config flag; the change rolls out in waves and the Operation is done when every cell serves it.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags/config-flag · scope config:write · effect write · long-running · Request, response and examples
#delete
Deletes a config flag; evaluators then get their compiled-in fallback.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags/config-flag · scope config:write · effect destructive · long-running · Request, response and examples
#evaluate
Evaluates config flags of an environment for one evaluation context: each flag's value, and why. Browsers and mobile apps call it with a publishable key holding config:evaluate, which reads values, never rules.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags:evaluate · scope config:evaluate · effect read · callable with a publishable key · Request, response and examples
#snapshot
The environment's flags and segments in one read, for SDKs that evaluate locally. Poll it with if_none_match set to the last etag: an unchanged ruleset answers not_modified and nothing else.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/config_flags:snapshot · scope config:read · effect read · Request, response and examples