Feature With Revisions V2

string

required

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

archived

boolean

required

description

string

required

Maximum string length: 10000

owner

string

required

The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization.

project

string

required

valueType

enum<string>

required

Available options:

boolean,

string,

number,

json

defaultValue

string

required

tags

string[]

required

rules

object · object · Feature Experiment Rule · object · object · object · Feature Safe Rollout Rule · object[]

required

Unified rules array. Each rule carries its own environment scope via allEnvironments / environments.

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

Show child attributes

environments

object

required

Per-environment enabled state and SDK payload. Rules are on the top-level rules field.

Show child attributes

revision

object

required

Show child attributes

targetingAllProjects

boolean

targetingProjects

string[]

baseConfig

string | null

Key of the config backing this flag ("Config mode"). Requires valueType: "json" and a live config. The config supplies the base JSON and schema; defaultValue and rule values are override patches on top. null or omitted for a plain flag.

defaultValueConfig

string | null

Optional. A config within baseConfig's family that the default value resolves to instead of baseConfig itself. null or omitted means the default is baseConfig. The default is exactly this config and carries no overrides of its own.

prerequisites

string[]

Feature IDs. Each feature must evaluate to true

customFields

object

Show child attributes

holdout

object | null

Show child attributes

revisions

object[]

Show child attributes

{
  "id": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "archived": true,
  "description": "<string>",
  "owner": "<string>",
  "project": "<string>",
  "defaultValue": "<string>",
  "tags": [
    "<string>"
  ],
  "rules": [
    {
      "description": "<string>",
      "id": "<string>",
      "enabled": true,
      "type": "force",
      "value": "<string>",
      "allEnvironments": true,
      "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>"
      ],
      "sparse": true,
      "config": "<string>",
      "environments": [
        "<string>"
      ]
    }
  ],
  "environments": {},
  "revision": {
    "version": 123,
    "comment": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "id": "<string>"
  },
  "targetingAllProjects": true,
  "targetingProjects": [
    "<string>"
  ],
  "baseConfig": "<string>",
  "defaultValueConfig": "<string>",
  "prerequisites": [
    "<string>"
  ],
  "customFields": {},
  "holdout": {
    "id": "<string>",
    "value": "<string>"
  },
  "revisions": [
    {
      "id": "<string>",
      "featureId": "<string>",
      "baseVersion": 123,
      "version": 123,
      "comment": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "rules": [
        {
          "description": "<string>",
          "id": "<string>",
          "enabled": true,
          "type": "force",
          "value": "<string>",
          "allEnvironments": true,
          "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>"
          ],
          "sparse": true,
          "config": "<string>",
          "environments": [
            "<string>"
          ]
        }
      ],
      "defaultValue": "<string>",
      "defaultValueConfig": "<string>",
      "definitions": {},
      "environmentsEnabled": {},
      "envPrerequisites": {},
      "prerequisites": [
        {
          "id": "<string>"
        }
      ],
      "metadata": {
        "description": "<string>",
        "owner": "<string>",
        "project": "<string>",
        "tags": [
          "<string>"
        ],
        "neverStale": true,
        "valueType": "<string>",
        "jsonSchema": {
          "schema": "<string>",
          "simple": {},
          "date": "2023-11-07T05:31:56Z",
          "enabled": true
        },
        "customFields": {},
        "baseConfig": "<string>"
      },
      "rampActions": [
        {
          "mode": "create",
          "ruleId": "<string>",
          "name": "<string>",
          "environment": "<string>",
          "templateId": "<string>",
          "startActions": [
            {
              "patch": {
                "ruleId": "<string>",
                "coverage": 0.5,
                "condition": "<string>",
                "savedGroups": [
                  {
                    "ids": [
                      "<string>"
                    ]
                  }
                ],
                "prerequisites": [
                  {
                    "id": "<string>",
                    "condition": "<string>"
                  }
                ],
                "allEnvironments": true,
                "environments": [
                  "<string>"
                ],
                "force": "<unknown>",
                "enabled": true
              },
              "targetType": "feature-rule",
              "targetId": "<string>"
            }
          ],
          "steps": [
            {
              "interval": 1,
              "actions": [
                {
                  "patch": {
                    "ruleId": "<string>",
                    "coverage": 0.5,
                    "condition": "<string>",
                    "savedGroups": [
                      {
                        "ids": [
                          "<string>"
                        ]
                      }
                    ],
                    "prerequisites": [
                      {
                        "id": "<string>",
                        "condition": "<string>"
                      }
                    ],
                    "allEnvironments": true,
                    "environments": [
                      "<string>"
                    ],
                    "force": "<unknown>",
                    "enabled": true
                  },
                  "targetType": "feature-rule",
                  "targetId": "<string>"
                }
              ],
              "approvalNotes": "<string>",
              "monitored": true,
              "holdConditions": {
                "minSampleSize": 123,
                "requiresApproval": true
              }
            }
          ],
          "endActions": [
            {
              "patch": {
                "ruleId": "<string>",
                "coverage": 0.5,
                "condition": "<string>",
                "savedGroups": [
                  {
                    "ids": [
                      "<string>"
                    ]
                  }
                ],
                "prerequisites": [
                  {
                    "id": "<string>",
                    "condition": "<string>"
                  }
                ],
                "allEnvironments": true,
                "environments": [
                  "<string>"
                ],
                "force": "<unknown>",
                "enabled": true
              },
              "targetType": "feature-rule",
              "targetId": "<string>"
            }
          ],
          "startDate": "2023-11-07T05:31:56Z",
          "cutoffDate": "2023-11-07T05:31:56Z",
          "requiresStartApproval": true
        }
      ],
      "autoPublishOnApproval": true,
      "scheduledPublishAt": "2023-11-07T05:31:56Z",
      "scheduledPublishLockEdits": true,
      "scheduledPublishLockOthers": true,
      "scheduledPublishBypassApproval": true,
      "scheduledPublishLastError": "<string>",
      "autoPublishEnabledBy": "<string>",
      "scheduledPublishAttempts": 123,
      "scheduledPublishGaveUpAt": "2023-11-07T05:31:56Z",
      "reviews": [
        {
          "userId": "<string>",
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Introduction

Endpoints

Models