Get all features in a project

GET 
/api/admin/projects/:projectId/features

A list of all features for the specified project.

Request

Path Parameters

projectId stringrequired

Responses

200

projectFeaturesSchema

application/json

Schema

Schema

version integerrequired

The version of the feature's schema

features

object[]

required

A list of features

Array [

name stringrequired

Unique feature name

Example: disable-comments

type stringrequired

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

Example: kill-switch

description stringnullablerequired

Detailed description of the feature

Example: Controls disabling of the comments section in case of an incident

stale booleanrequired

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

Example: false

favorite booleanrequired

true if the feature was favorited, otherwise false.

Example: true

impressionData booleanrequired

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

Example: false

createdAt date-timerequired

The date the feature was created

Example: 2023-01-28T15:21:39.975Z

lastSeenAt date-timenullablerequireddeprecated

The date and time when metrics where last collected for this flag in any environment. This field was deprecated in v5. You should instead use the lastSeenAt property on the individual environments listed under the environments property.

Example: 2023-01-28T16:21:39.975Z

environments

object[]

required

The list of environments where the feature can be used

Array [

name stringrequired

The name of the environment

Example: my-dev-env

type stringrequired

The type of the environment

Example: development

enabled booleanrequired

true if the feature is enabled for the environment, otherwise false.

Example: true

sortOrder numberrequired

The sort order of the feature environment in the feature environments list

Example: 3

variantCount numberrequired

The number of defined variants

lastSeenAt date-timenullablerequired

The date when metrics where last collected for the feature environment

Example: 2023-01-28T16:21:39.975Z

hasStrategies boolean

Whether the feature has any strategies defined.

hasEnabledStrategies boolean

Whether the feature has any enabled strategies defined.

]

tags

object[]

nullable

The list of feature tags

Array [

value stringrequired

The value of the tag.

Possible values: >= 2 characters and <= 50 characters

Example: a-tag-value

type stringrequired

The type of the tag

Possible values: >= 2 characters and <= 50 characters

Example: simple

]

]

Example (from schema)

{
  "version": 0,
  "features": [
    {
      "name": "disable-comments",
      "type": "kill-switch",
      "description": "Controls disabling of the comments section in case of an incident",
      "stale": false,
      "favorite": true,
      "impressionData": false,
      "createdAt": "2023-01-28T15:21:39.975Z",
      "environments": [
        {
          "name": "my-dev-env",
          "type": "development",
          "enabled": true,
          "sortOrder": 3,
          "variantCount": 0,
          "lastSeenAt": "2023-01-28T16:21:39.975Z",
          "hasStrategies": true,
          "hasEnabledStrategies": true
        }
      ],
      "tags": [
        {
          "value": "a-tag-value",
          "type": "simple"
        }
      ]
    }
  ]
}

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Loading...