Get all feature types

GET /api/admin/feature-types

Retrieves all feature types that exist in this Unleash instance, along with their descriptions and lifetimes.

Request

Responses

• 200
• 401

---

featureTypesSchema

application/json

Schema

Schema

• version integer required

  Possible values: [1]

  The schema version used to describe the feature flag types listed in the types property.

• types object[]required

  The list of feature flag types.

  Array [

  id string required

  The identifier of this feature flag type.

  name string required

  The display name of this feature flag type.

  description string required

  A description of what this feature flag type is intended to be used for.

  lifetimeDays integer nullable required

  How many days it takes before a feature flag of this typed is flagged as potentially stale by Unleash. If this value is null, Unleash will never mark it as potentially stale.

  ]

Example (from schema)

{
  "version": 1,
  "types": [
    {
      "id": "release",
      "name": "Release",
      "description": "Release feature flags are used to release new features.",
      "lifetimeDays": 40
    },
    {
      "id": "experiment",
      "name": "Experiment",
      "description": "Experiment feature flags are used to test and verify multiple different versions of a feature.",
      "lifetimeDays": 40
    },
    {
      "id": "operational",
      "name": "Operational",
      "description": "Operational feature flags are used to control aspects of a rollout.",
      "lifetimeDays": 7
    },
    {
      "id": "kill-switch",
      "name": "Kill switch",
      "description": "Kill switch feature flags are used to quickly turn on or off critical functionality in your system.",
      "lifetimeDays": null
    },
    {
      "id": "permission",
      "name": "Permission",
      "description": "Permission feature flags are used to control permissions in your system.",
      "lifetimeDays": null
    }
  ]
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

Loading...