data [required]
\nobject
Data wrapper for targeting rule allocation responses.
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute [required]
\nstring
The user or request attribute to evaluate.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator [required]
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value [required]
\n[string]
Values used by the selected operator.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\nobject
Data wrapper for targeting rule allocation responses.
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute
\nstring
The user or request attribute to evaluate. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
saved_filter_id
\nuuid
The ID of the saved filter referenced by this condition, or null for inline conditions.
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value
\n[string]
Values used by the selected operator. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\nobject
Data wrapper for targeting rule allocation responses.
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute [required]
\nstring
The user or request attribute to evaluate.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator [required]
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value [required]
\n[string]
Values used by the selected operator.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\nobject
Data wrapper for targeting rule allocation responses.
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute
\nstring
The user or request attribute to evaluate. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
saved_filter_id
\nuuid
The ID of the saved filter referenced by this condition, or null for inline conditions.
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value
\n[string]
Values used by the selected operator. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\nobject
Data wrapper for allocation request payloads.
attributes [required]
\nobject
Request to create or update a targeting rule (allocation) for a feature flag environment.
experiment_id
\nstring
The experiment ID for experiment-linked allocations.
exposure_schedule
\nobject
Progressive release request payload.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
control_variant_key
\nstring
The control variant key used during creation workflows.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Rollout options request payload.
autostart
\nboolean
Whether the schedule should begin automatically.
selection_interval_ms
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
guardrail_metrics
\n[object]
Guardrail metrics used to monitor and auto-pause or abort.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
targeting_rules
\n[object]
Targeting rules that determine audience eligibility.
conditions [required]
\n[object]
Conditions that must match for this rule.
attribute [required]
\nstring
The user or request attribute to evaluate.
operator [required]
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
value [required]
\n[string]
Values used by the selected operator.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
variant_weights
\n[object]
Variant distribution weights.
value [required]
\ndouble
The percentage weight for this variant.
variant_id
\nuuid
The variant ID to assign weight to.
variant_key
\nstring
The variant key to assign weight to.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\nobject
Data wrapper for allocation request payloads.
attributes [required]
\nobject
Request to create or update a targeting rule (allocation) for a feature flag environment.
experiment_id
\nstring
The experiment ID for experiment-linked allocations.
exposure_schedule
\nobject
Progressive release request payload.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
control_variant_key
\nstring
The control variant key used during creation workflows.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Rollout options request payload.
autostart
\nboolean
Whether the schedule should begin automatically.
selection_interval_ms
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
guardrail_metrics
\n[object]
Guardrail metrics used to monitor and auto-pause or abort.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
targeting_rules
\n[object]
Targeting rules that determine audience eligibility.
conditions [required]
\n[object]
Conditions that must match for this rule.
attribute
\nstring
The user or request attribute to evaluate. Required for inline conditions; omit when saved_filter_id is set.
operator
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
saved_filter_id
\nuuid
The ID of a saved filter to reference as this condition. Mutually exclusive\nwith operator, attribute, and value. When set, the saved filter's\ntargeting rules are evaluated in place of an inline predicate.
value
\n[string]
Values used by the selected operator. Required for inline conditions; omit when saved_filter_id is set.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
variant_weights
\n[object]
Variant distribution weights.
value [required]
\ndouble
The percentage weight for this variant.
variant_id
\nuuid
The variant ID to assign weight to.
variant_key
\nstring
The variant key to assign weight to.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\n[object]
List of targeting rules (allocations).
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute [required]
\nstring
The user or request attribute to evaluate.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator [required]
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value [required]
\n[string]
Values used by the selected operator.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\n[object]
List of targeting rules (allocations).
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute
\nstring
The user or request attribute to evaluate. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
saved_filter_id
\nuuid
The ID of the saved filter referenced by this condition, or null for inline conditions.
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value
\n[string]
Values used by the selected operator. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\n[object]
List of targeting rules (allocations).
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute [required]
\nstring
The user or request attribute to evaluate.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator [required]
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value [required]
\n[string]
Values used by the selected operator.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\n[object]
List of targeting rules (allocations).
attributes [required]
\nobject
Targeting rule (allocation) details for a feature flag environment.
created_at [required]
\ndate-time
The timestamp when the targeting rule allocation was created.
environment_ids [required]
\n[string]
Environment IDs associated with this targeting rule allocation.
experiment_id
\nstring
The experiment ID linked to this targeting rule allocation.
exposure_schedule
\nobject
Progressive release details for a targeting rule allocation.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
allocation_id [required]
\nuuid
The targeting rule allocation ID this progressive rollout belongs to.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
created_at [required]
\ndate-time
The timestamp when the schedule was created.
guardrail_triggered_action
\nstring
Last guardrail action triggered for this schedule.
guardrail_triggers [required]
\n[object]
Guardrail trigger records for this schedule.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this trigger belongs to.
created_at [required]
\ndate-time
The timestamp when this trigger was created.
flagging_variant_id [required]
\nuuid
The variant ID that triggered this event.
id [required]
\nuuid
The unique identifier of the guardrail trigger.
metric_id [required]
\nstring
The metric ID associated with the trigger.
triggered_action [required]
\nstring
The action that was triggered.
updated_at [required]
\ndate-time
The timestamp when this trigger was last updated.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Applied progression options for a progressive rollout.
autostart [required]
\nboolean
Whether the schedule starts automatically.
selection_interval_ms [required]
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
allocation_exposure_schedule_id [required]
\nuuid
The progressive rollout ID this step belongs to.
created_at [required]
\ndate-time
The timestamp when the progression step was created.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id [required]
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
order_position [required]
\nint64
Sort order for the progression step.
updated_at [required]
\ndate-time
The timestamp when the progression step was last updated.
updated_at [required]
\ndate-time
The timestamp when the schedule was last updated.
guardrail_metrics [required]
\n[object]
Guardrail metrics associated with this targeting rule allocation.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
triggered_by
\nstring
The signal or system that triggered the action.
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
order_position [required]
\nint64
Sort order position within the environment.
targeting_rules [required]
\n[object]
Conditions associated with this targeting rule allocation.
conditions [required]
\n[object]
Conditions evaluated by this targeting rule.
attribute
\nstring
The user or request attribute to evaluate. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the condition was created.
id [required]
\nuuid
The unique identifier of the condition.
operator
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
saved_filter_id
\nuuid
The ID of the saved filter referenced by this condition, or null for inline conditions.
updated_at [required]
\ndate-time
The timestamp when the condition was last updated.
value
\n[string]
Values used by the selected operator. Omitted for saved-filter references.
created_at [required]
\ndate-time
The timestamp when the targeting rule was created.
id [required]
\nuuid
The unique identifier of the targeting rule.
updated_at [required]
\ndate-time
The timestamp when the targeting rule was last updated.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
updated_at [required]
\ndate-time
The timestamp when the targeting rule allocation was last updated.
variant_weights [required]
\n[object]
Weighted variant assignments for this targeting rule allocation.
created_at
\ndate-time
The timestamp when the variant weight was created.
id
\nuuid
Unique identifier of the variant weight assignment.
updated_at
\ndate-time
The timestamp when the variant weight was last updated.
value [required]
\ndouble
The percentage weight for the variant.
variant
\nobject
A variant of a feature flag.
created_at
\ndate-time
The timestamp when the variant was created.
id [required]
\nuuid
The unique identifier of the variant.
key [required]
\nstring
The unique key of the variant.
name [required]
\nstring
The name of the variant.
updated_at
\ndate-time
The timestamp when the variant was last updated.
value [required]
\nstring
The value of the variant as a string.
variant_id [required]
\nuuid
The variant ID.
id [required]
\nuuid
The unique identifier of the targeting rule allocation.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\n[object]
Targeting rules (allocations) to replace existing ones with.
attributes [required]
\nobject
Request to create or update a targeting rule (allocation) for a feature flag environment.
experiment_id
\nstring
The experiment ID for experiment-linked allocations.
exposure_schedule
\nobject
Progressive release request payload.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
control_variant_key
\nstring
The control variant key used during creation workflows.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Rollout options request payload.
autostart
\nboolean
Whether the schedule should begin automatically.
selection_interval_ms
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
guardrail_metrics
\n[object]
Guardrail metrics used to monitor and auto-pause or abort.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
targeting_rules
\n[object]
Targeting rules that determine audience eligibility.
conditions [required]
\n[object]
Conditions that must match for this rule.
attribute [required]
\nstring
The user or request attribute to evaluate.
operator [required]
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
value [required]
\n[string]
Values used by the selected operator.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
variant_weights
\n[object]
Variant distribution weights.
value [required]
\ndouble
The percentage weight for this variant.
variant_id
\nuuid
The variant ID to assign weight to.
variant_key
\nstring
The variant key to assign weight to.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations
data [required]
\n[object]
Targeting rules (allocations) to replace existing ones with.
attributes [required]
\nobject
Request to create or update a targeting rule (allocation) for a feature flag environment.
experiment_id
\nstring
The experiment ID for experiment-linked allocations.
exposure_schedule
\nobject
Progressive release request payload.
absolute_start_time
\ndate-time
The absolute UTC start time for this schedule.
control_variant_id
\nstring
The control variant ID used for experiment comparisons.
control_variant_key
\nstring
The control variant key used during creation workflows.
id
\nuuid
The unique identifier of the progressive rollout.
rollout_options [required]
\nobject
Rollout options request payload.
autostart
\nboolean
Whether the schedule should begin automatically.
selection_interval_ms
\nint64
Interval in milliseconds for uniform interval strategies.
strategy [required]
\nenum
The progression strategy used by a progressive rollout. \nAllowed enum values: UNIFORM_INTERVALS,NO_ROLLOUT
rollout_steps [required]
\n[object]
Ordered progression steps for exposure.
exposure_ratio [required]
\ndouble
The exposure ratio for this step.
grouped_step_index [required]
\nint64
Logical index grouping related steps.
id
\nuuid
The unique identifier of the progression step.
interval_ms
\nint64
Step duration in milliseconds.
is_pause_record [required]
\nboolean
Whether this step represents a pause record.
guardrail_metrics
\n[object]
Guardrail metrics used to monitor and auto-pause or abort.
metric_id [required]
\nstring
The metric ID to monitor.
trigger_action [required]
\nenum
Action to perform when a guardrail threshold is triggered. \nAllowed enum values: PAUSE,ABORT
id
\nuuid
The unique identifier of the targeting rule allocation.
key [required]
\nstring
The unique key of the targeting rule allocation.
name [required]
\nstring
The display name of the targeting rule.
targeting_rules
\n[object]
Targeting rules that determine audience eligibility.
conditions [required]
\n[object]
Conditions that must match for this rule.
attribute
\nstring
The user or request attribute to evaluate. Required for inline conditions; omit when saved_filter_id is set.
operator
\nenum
The operator used in a targeting condition. \nAllowed enum values: LT,LTE,GT,GTE,MATCHES,NOT_MATCHES,ONE_OF,NOT_ONE_OF,IS_NULL,EQUALS
saved_filter_id
\nuuid
The ID of a saved filter to reference as this condition. Mutually exclusive\nwith operator, attribute, and value. When set, the saved filter's\ntargeting rules are evaluated in place of an inline predicate.
value
\n[string]
Values used by the selected operator. Required for inline conditions; omit when saved_filter_id is set.
type [required]
\nenum
The type of targeting rule (called allocation in the API model). \nAllowed enum values: FEATURE_GATE,CANARY
variant_weights
\n[object]
Variant distribution weights.
value [required]
\ndouble
The percentage weight for this variant.
variant_id
\nuuid
The variant ID to assign weight to.
variant_key
\nstring
The variant key to assign weight to.
type [required]
\nenum
The resource type. \nAllowed enum values: allocations