Features

Add a new feature flag

Create a new feature flag in a specified project.

post/api/admin/projects/{projectId}/features

Path parameters

projectIdstring required

Request body

namestring required

Unique feature name

type'experiment' | 'kill-switch' | 'release' | 'operational' | 'permission' | 'sunset'

The feature flag's type. One of experiment, kill-switch, release, operational, permission, or sunset

descriptionstring nullable

Detailed description of the feature

impressionDataboolean

true if the impression data collection is enabled for the feature, otherwise false.

Example request

{
  "name": "disable-comments",
  "type": "release",
  "description": "Controls disabling of the comments section in case of an incident",
  "tags": [
    {
      "value": "a-tag-value",
      "type": "simple",
      "color": "#FFFFFF"
    }
  ]
}

Response

featureSchema

namestring required

Unique feature name

typestring

Type of the flag e.g. experiment, kill-switch, release, operational, permission

descriptionstring nullable

Detailed description of the feature

archivedboolean

true if the feature is archived

projectstring

Name of the project the feature belongs to

enabledboolean

true if the feature is enabled, otherwise false.

staleboolean

true if the feature is stale based on the age and feature type, otherwise false.

favoriteboolean

true if the feature was favorited, otherwise false.

impressionDataboolean

true if the impression data collection is enabled for the feature, otherwise false.

createdAtstring date-time nullable

The date the feature was created

archivedAtstring date-time nullable

The date the feature was archived

childrenstring[]

The list of child feature names. This is an experimental field and may change.

Changes

Changed in 2 of the 7 revisions of this API.96

    • added the new SEMVER_GTE enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • added the new SEMVER_GTE enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new SEMVER_LTE enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • added the new SEMVER_LTE enum value to the ////// response property for the response status

      response-property-enum-value-added

  • 774670258f0456See the full diff
    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the new REGEX enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • added the new REGEX enum value to the ////// response property for the response status

      response-property-enum-value-added

    • added the new sunset enum value to the request property

      request-property-enum-value-added

    • added the optional property //////// to the response with the status

      response-optional-property-added

    • added the optional property /////// to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • response property environments/items/releasePlans/items/milestones/items/strategies/items/strategyName deprecated (stability: stable)

      response-property-deprecated

    • added the required property //////// to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog