API Reference

Evaluate a flag

Evaluate one flag for the supplied evaluation context. Authenticated by an SDK key, which pins the organization and environment.

Evaluate all flags

Evaluate every flag configured in the SDK key's environment for the supplied context. Each entry is a success object or a per-flag failure object, so one misconfigured flag never fails the call.

List flags

List every flag in the organization with its per-environment configuration.

Create a flag

Create a flag. Flags are created disabled in every environment; enable them per environment afterwards.

Get a flag

Update a flag

Edit flag metadata: name, description, maintainer, permanence, and tags.

Delete a flag

Permanently delete a flag. Evaluation of the key stops, so remove all references first.

Get flag usage

Evaluation counts and recency for the flag, per environment.

Archive a flag

Retire a flag. It disappears from the active list but keeps evaluating, so existing clients never break.

Restore a flag

Return an archived flag to the active list so its configuration can be edited again.

Configure a flag in an environment

Set the on/off state, the default variant or rollout, and the off variant for a flag in one environment.

Create a variant

Add a variant to a multivariate flag. Boolean flags have fixed on/off variants and reject this.

Update a variant

Edit a variant's value or label.

Delete a variant

Remove a variant. Rejected while a default, off value, or targeting rule still references it.

List targeting rules

List the flag's targeting rules for an environment, in priority order.

Create a targeting rule

Append a targeting rule to a flag's environment. Rules serve in priority order (lowest first).

Replace all targeting rules

Replace the environment's entire ordered rule set in one atomic transaction, recorded as a single revision.

Update a rule

Edit a single targeting rule's description, conditions, serve, or priority.

Delete a rule

Remove a single targeting rule from a flag's environment.

Reorder rules

Set the priority order of the environment's rules from an ordered list of rule ids.

List segments

List every segment in the organization.

Create a segment

Create a reusable targeting segment: a named group of conditions that rules can reference.

Get a segment

Update a segment

Edit a segment's name, description, or conditions.

Delete a segment

Permanently delete a segment.

List entities

List every entity in the organization with its attributes.

Create an entity

Define a targeting entity (e.g. user, team) and its typed attributes that rules and segments reference.

Update an entity

Edit an entity's label or replace its attribute set.

Delete an entity

Permanently delete an entity and its attributes.

List environments

List the organization's environments (Production, Preview, Development), seeded on first read.

List SDK keys

List the organization's SDK keys as masked metadata. The secret is never returned.

Mint an SDK key

Create an SDK key for one environment. The plaintext token is returned once at creation and never again.

Revoke an SDK key

Revoke an SDK key so it can no longer be used to evaluate flags.

List members

List the organization's members with their name, email, and role.

Join the waitlist

Record an email address for early access. Submitting the same address again is a no-op success.

Health check

Liveness probe. Returns the current server time; never touches the database.

Identify the caller

Resolve the authenticated identity for this request. Send a personal or organization access token as `Authorization: Bearer <token>`, or call from a browser that holds a valid Flagon session cookie. Returns 401 when neither is present or valid.