Feature With Revisions V1

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 of the owner (or raw owner name/email for legacy records)

project

string

required

valueType

enum<string>

required

Available options:

boolean,

string,

number,

json

defaultValue

string

required

tags

string[]

required

environments

object

required

Show child attributes

revision

object

required

Show child attributes

ownerEmail

string

The email address of the owner, when the owner can be resolved to a known user.

targetingAllProjects

boolean

targetingProjects

string[]

baseConfig

string | null

Key of the config backing this flag ("Config mode"), or null. The config supplies the base JSON and schema. The internal @config: directive is scrubbed from values; @const: references are preserved. (v2 additionally exposes per-rule config fields.)

defaultValueConfig

string | null

Config within baseConfig's family that the default value resolves to (a descendant), or null when the default uses baseConfig directly.

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>"
  ],
  "environments": {},
  "revision": {
    "version": 123,
    "comment": "<string>",
    "date": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "publishedBy": "<string>",
    "id": "<string>"
  },
  "ownerEmail": "<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": {},
      "createdBy": "<string>",
      "publishedBy": "<string>",
      "defaultValue": "<string>",
      "definitions": {},
      "environmentsEnabled": {},
      "envPrerequisites": {},
      "prerequisites": [
        {
          "id": "<string>",
          "condition": "<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
        }
      ]
    }
  ]
}

Introduction

Endpoints

Models