Skip to main content
PATCH
/
api
/
v1
/
api-keys
/
{apiKeyId}
Patch API Key
curl --request PATCH \
  --url https://api.example.com/api/v1/api-keys/{apiKeyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "scope": {
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "accountIds": [
      "123e4567-e89b-12d3-a456-426614174001"
    ],
    "widgetIds": [
      "123e4567-e89b-12d3-a456-426614174002"
    ],
    "environmentIds": [
      "123e4567-e89b-12d3-a456-426614174003"
    ]
  }
}

Path Parameters

apiKeyId
string
required

The unique identifier of the API key to update

Example:

"decafbad-cafe-4dad-f00d-123456789abc"

Body

application/json
name
string
required
description
string
required

Response

id
string
required
name
string
required
description
string
required
scope
object
required