Skip to main content

Common fields shared by all feature rule types. Specific rule types extend this base with their own required properties (value, coverage, etc.).

​
description
string
required
Maximum string length: 10000
​
id
string
required
​
enabled
boolean
required
​
type
string
required
Allowed value: "force"
​
value
string
required
​
allEnvironments
boolean
required

When true the rule applies to all environments. When false only the environments listed in environments receive the rule.

​
condition
string
​
scheduleRules
object[]

Simple time-based on/off schedule for this rule

​
scheduleType
enum<string>

UI hint for which scheduling mode is active:

  • none – no schedule
  • schedule – simple time-based enable/disable via scheduleRules
  • ramp – multi-step ramp-up controlled by an associated RampSchedule document
Available options:
none,
schedule,
ramp
​
rampScheduleId
string

ID of the active RampSchedule document controlling this rule. Present when scheduleType is ramp and a live schedule exists.

​
savedGroupTargeting
object[]
​
prerequisites
object[]
​
sparse
boolean

JSON features only. When true, value is a partial object merged onto the feature's default value instead of replacing it.

​
environments
string[]

The environment IDs this rule is active in. Populated when allEnvironments is false.

​
pendingRamp
enum<string>

Present on draft revisions only. "create" means a ramp schedule will be created for this rule on publish. "detach" means an existing live ramp schedule will be removed on publish. Use PUT/DELETE .../rules/{ruleId}/ramp-schedule to modify.

Available options:
create,
detach