Optional requestFactory: FeatureFlagsApiRequestFactoryOptional responseProcessor: FeatureFlagsApiResponseProcessorPrivate configurationPrivate requestPrivate responseThe request object
Optional options: ConfigurationCreates a new targeting rule (allocation) for a specific feature flag in a specific environment.
The request object
Optional options: ConfigurationCreates a new feature flag with variants.
The request object
Optional options: ConfigurationCreates a new environment for organizing feature flags.
The request object
Optional options: ConfigurationAdds a single new variant to an existing feature flag. This endpoint is
additive-only: it never modifies existing variants. A request whose key
already exists on the flag is rejected with 409 Conflict; a value
whose type does not match the flag's value_type is rejected with 400.
The server generates the variant UUID and returns it in the response body;
callers (for example, the flag-migration tool) need this UUID to reference
the new variant in subsequent allocation syncs.
The request object
Optional options: ConfigurationDeletes an environment. This operation cannot be undone.
The request object
Optional options: ConfigurationDeletes a variant from a feature flag.
When backend approvals are enabled and the flag requires approval, this endpoint creates and returns a FlagSuggestion with 201 Created instead of deleting the variant immediately. If a pending suggestion already exists for this flag's variant property, the endpoint returns 409 Conflict.
The request object
Optional options: ConfigurationDisable a feature flag in a specific environment.
The request object
Optional options: ConfigurationEnable a feature flag in a specific environment.
The request object
Optional options: ConfigurationReturns the details of a specific feature flag including variants and environment status.
The request object
Optional options: ConfigurationReturns the details of a specific environment.
The request object
Optional options: ConfigurationReturns a saved filter by ID, including its full targeting rules, conditions, and values. Supports both saved lists and saved rules. Targeting rules are combined with OR, and conditions within each rule are combined with AND. Returns the stored filter definition rather than evaluating it against users or organizations. Archived filters can be retrieved. Filters that are deleted or belong to another organization return a not found error.
The request object
Optional options: ConfigurationReturns a paginated list of feature flags for the organization.
Supports filtering by key, tags, teams, SDK availability, production status, and other flag properties.
Use page[limit] and page[offset] to paginate, or follow the next link in the response.
The request object
Optional options: ConfigurationReturns a list of environments for the organization. Supports filtering by name, key, and DD_ENV.
The request object
Optional options: ConfigurationPauses a progressive rollout while preserving rollout state.
The request object
Optional options: ConfigurationResumes progression for a previously paused progressive rollout.
The request object
Optional options: ConfigurationStarts a progressive rollout and begins progression.
The request object
Optional options: ConfigurationStops a progressive rollout and marks it as aborted.
The request object
Optional options: ConfigurationUnarchives a previously archived feature flag, making it visible in the main list again.
The request object
Optional options: ConfigurationUpdates targeting rules (allocations) for a specific feature flag in a specific environment. This operation replaces the existing allocation set with the request payload.
The request object
Optional options: ConfigurationUpdates an existing feature flag's metadata such as name and description. Does not modify targeting rules or allocations.
To change the owning team, update tags and include a tag of the form
team:<team-handle> in the array. tags is a full replacement of the
existing tag set (including any team: tag), so include every tag you
want to keep, not just the ones you're adding.
The request object
Optional options: ConfigurationUpdates an existing environment's metadata such as name and description.
The request object
Optional options: ConfigurationPartially updates a saved filter. Supports both LIST and RULES filters.
Supply at least one of name, description, or targeting_rules. Omitted or null fields
are preserved. Supplying targeting_rules replaces the entire collection and propagates
changes to every feature flag that references the saved filter.
Metadata-only updates do not require edit permission or approval on those feature flags.
Rule updates require edit permission on all consumer flags and are rejected when approval
is required, unless the caller has the feature_flag_approvals_override permission.
The optional last_updated_at field detects stale updates. It does not set the update time.
The request object
Optional options: ConfigurationUpdates the name and value of an existing variant on a feature flag.
When backend approvals are enabled and the flag requires approval, this endpoint creates and returns a FlagSuggestion with 201 Created instead of applying the change immediately. Use the returned suggestion id to approve or reject the change. If a pending suggestion already exists for this flag's variant property, the endpoint returns 409 Conflict.
The request object
Optional options: ConfigurationGenerated using TypeDoc
Archives a feature flag. Archived flags are hidden from the main list but remain accessible and can be unarchived.