Update API Key

Update name and/or permissions for an API key.

Updates the name and/or permissions associated with this API key. Requires a member or owner role (with the update:api_credentials permission) in the organization that owns the application.

Returns: The API key with updated fields and timestamp.

Note: For permissions, this completely replaces the existing permissions with the new list. Name and permissions are both optional - provide only the fields you want to update.

PATCH /api-keys/{api_key}

Update Api Key

cURL

curl --request PATCH \
  --url https://management-api.unomiq.com/api-keys/{api_key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ]
}
'

200

{
  "api_key": "<string>",
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "updated_at": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

api_key · string · required

Body

application/json

name · string | null

The API key's name

Required string length: 1 - 255

permissions · string[] | null

List of permissions to grant to this credential. Allowed values: write:traces, read:traces

Minimum array length: 1

Allowed value: "write:traces"

Response

200

application/json

Successful Response

api_key · string · required

name · string · required

permissions · string[] · required

Allowed value: "write:traces"

updated_at · string · required