Get archived features

GET /api/admin/archive/features

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Retrieve a list of all archived feature flags.

Request

Responses

• 200
• 401
• 403

---

archivedFeaturesSchema

application/json

Schema

Schema

• version integer required

  The version of the feature's schema

• features object[]required

  A list of features

  Array [

  name string required

  Unique feature name

  type string

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

  description string nullable

  Detailed description of the feature

  project string required

  Name of the project the feature belongs to

  stale boolean

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

  impressionData boolean

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

  createdAt date-time

  The date the feature was created

  archivedAt date-time

  The date the feature was archived

  lastSeenAt date-time nullable deprecated

  The date when metrics where last collected for the feature. This field was deprecated in v5, use the one in featureEnvironmentSchema

  environments object[]deprecated

  The list of environments where the feature can be used

  Array [

  name string

  The name of the environment

  lastSeenAt date-time nullable

  The date when metrics where last collected for the feature environment

  enabled boolean

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

  ]

  ]

Example (from schema)

{
  "version": 0,
  "features": [
    {
      "name": "disable-comments",
      "type": "kill-switch",
      "description": "Controls disabling of the comments section in case of an incident",
      "project": "dx-squad",
      "stale": false,
      "impressionData": false,
      "createdAt": "2023-01-28T15:21:39.975Z",
      "archivedAt": "2023-01-29T15:21:39.975Z"
    }
  ]
}

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

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

• 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": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Loading...