Feature Safe Rollout Rule

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

string

required

enabled

boolean

required

type

string

required

Allowed value: "safe-rollout"

controlValue

string

required

variationValue

string

required

condition

string

scheduleRules

object[]

Simple time-based on/off schedule for this rule

Show child attributes

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[]

Show child attributes

prerequisites

object[]

Show child attributes

allProjects

boolean

When true (the default) the rule applies to every project the feature is delivered to. When false the rule is limited to projects.

projects

string[]

Project IDs this rule is scoped to when allProjects is false. An empty array scopes the rule to no project.

seed

string

hashAttribute

string

trackingKey

string

safeRolloutId

string

status

enum<string>

Available options:

running,

released,

rolled-back,

stopped

{
  "description": "<string>",
  "id": "<string>",
  "enabled": true,
  "type": "safe-rollout",
  "controlValue": "<string>",
  "variationValue": "<string>",
  "condition": "<string>",
  "scheduleRules": [
    {
      "enabled": true,
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "rampScheduleId": "<string>",
  "savedGroupTargeting": [
    {
      "savedGroups": [
        "<string>"
      ]
    }
  ],
  "prerequisites": [
    {
      "id": "<string>",
      "condition": "<string>"
    }
  ],
  "allProjects": true,
  "projects": [
    "<string>"
  ],
  "seed": "<string>",
  "hashAttribute": "<string>",
  "trackingKey": "<string>",
  "safeRolloutId": "<string>"
}

Introduction

Endpoints

Models