Skip to main content
PATCH
Rebind an alert ingest credential

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

credential_id
string<uuid>
required

Body

application/json

At least one key must be present: an empty body answers 422 on cluster_id.

cluster_id
string<uuid> | null

The cluster to pin the credential to, or null to unpin it. Omit the key to leave the pin as it is.

scope
enum<string>

Which alerts the credential delivers. Omit the key to leave the scope as it is.

Available options:
cluster,
platform,
mixed

Response

Successful Response

item
AlertIngestCredentialItem · object
required
previous_cluster_id
string<uuid> | null
required

The cluster the credential was pinned to before this change, or null when it was unpinned.