Features

Update a feature flag

Changed on

Updates the specified feature if the feature belongs to the specified project. Only the provided properties are updated; any feature properties left out of the request body are left untouched.

put/api/admin/projects/{projectId}/features/{featureName}

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/projects/{projectId}/features/{featureName}
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Path parameters

projectIdstring required
featureNamestring required

Request body

descriptionstring

Detailed description of the feature

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

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

staleboolean

true if the feature is archived

archivedboolean

If true the feature flag will be moved to the archive with a property archivedAt set to current time

impressionDataboolean

true if the impression data collection is enabled for the feature

Example request

{
  "description": "Controls disabling of the comments section in case of an incident",
  "type": "kill-switch",
  "stale": true,
  "archived": true
}

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

  • b2c3116e633eRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • 774670258f04Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

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

    • warning

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

    • info

      added the new sunset enum value to the request property

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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