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 list of feature flags for the organization. Supports filtering by key and archived status.
The request object
Optional options: ConfigurationReturns a list of environments for the organization. Supports filtering by name and key.
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.
The request object
Optional options: ConfigurationUpdates an existing environment's metadata such as name and description.
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.