Read Key

GET /console/v1/keys/{id}

Try it

Read Key

cURL

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

200

{
  "message": "Key read successfully.",
  "data": {
    "key": "secret-123",
    "type": "SERVER",
    "description": "Server secret key",
    "scopes": [],
    "environments": [
      "production"
    ],
    "primaryTargetApp": "primaryApp",
    "secondaryTargetApps": [
      "secondaryApp"
    ],
    "status": "active"
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id · string · required

Response

200

application/json

Key read successfully

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

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