List Keys

GET /console/v1/keys

Try it

List Keys

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/keys \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "Keys listed successfully.",
  "data": [
    {
      "key": "secret-123",
      "type": "SERVER",
      "description": "Server secret key",
      "scopes": [],
      "environments": [
        "production"
      ],
      "primaryTargetApp": "primaryApp",
      "secondaryTargetApps": [
        "secondaryApp"
      ],
      "status": "active"
    },
    {
      "key": "console-123",
      "type": "CONSOLE",
      "description": "Console API key",
      "scopes": [
        "omni_read_write",
        "can_access_keys"
      ],
      "status": "active"
    }
  ]
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Query Parameters

primaryTargetApp · string

environment · string

limit · integer

Results per page

Example:

10

page · integer

Page number

Example:

1

Response

200

application/json

Keys listed successfully

message · string · required

A simple string explaining the result of the operation.

data · object[] · required

Array of results returned by pagination limit.

Show child attributes

data. key · string | null · required

data. type · enum<string> · required

Available options: SERVER, CLIENT, CONSOLE, SCIM

data. description · string · required

data. scopes · enum<string>[] · required

Available options: omni_read_only, omni_read_write, client_download_config_specs, none_hash_enabled, can_access_keys

data. status · enum<string> · required

Available options: active, deactivated

data. environments · string[]

data. primaryTargetApp · string | null

data. secondaryTargetApps · string[] | null

pagination · object · required

Pagination metadata for checking if there is next page for example.

Show child attributes

pagination. itemsPerPage · number · required

pagination. pageNumber · number · required

pagination. nextPage · string | null · required

pagination. previousPage · string | null · required

pagination. totalItems · number

pagination. all · string