Skip to main content
PATCH
/
console
/
v1
/
keys
/
{id}
Update Key
curl --request PATCH \
  --url https://statsigapi.net/console/v1/keys/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "description": "<string>",
  "scopes": [],
  "environments": [
    "<string>"
  ],
  "targetAppID": "<string>",
  "secondaryTargetAppIDs": [
    "<string>"
  ]
}
'
{
  "message": "Key updated successfully.",
  "data": {
    "environments": [
      "staging"
    ],
    "targetAppID": "primaryApp",
    "secondaryTargetAppIDs": null
  }
}

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

Body

application/json
​
description
string
Maximum string length: 1000
​
scopes
enum<string>[]
Available options:
omni_read_only,
omni_read_write,
client_download_config_specs,
none_hash_enabled,
can_access_keys,
client_can_write_user_store,
personal_read_only,
personal_read_write
​
environments
string[]
​
targetAppID
string | null
​
secondaryTargetAppIDs
string[] | null

Response

Key updated successfully

​
message
string
required

A simple string explaining the result of the operation.

​
data
object
required

A single result.