Get archived features in project

GET 
/api/admin/archive/features/:projectId

deprecated

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

Retrieves a list of archived features that belong to the provided project.

Request

Path Parameters

projectId stringrequired

Responses

200

archivedFeaturesSchema

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 string

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

Example: kill-switch

description stringnullable

Detailed description of the feature

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

project stringrequired

Name of the project the feature belongs to

Example: dx-squad

stale boolean

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

Example: false

impressionData boolean

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

Example: false

createdAt date-time

The date the feature was created

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

archivedAt date-time

The date the feature was archived

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

lastSeenAt date-timenullabledeprecated

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

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

environments

object[]

deprecated

The list of environments where the feature can be used

Array [

name string

The name of the environment

Example: my-dev-env

lastSeenAt date-timenullable

The date when metrics where last collected for the feature environment

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

enabled boolean

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

Example: true

]

]

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

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