Skip to content

Acknowledge a compliance alert

POST
/api/v1/compliance/alerts/{alert_id}/acknowledge

Mark a compliance alert as acknowledged.

Authorizations

Parameters

Path Parameters

alert_id
required
string

Responses

200

Successful Response

Typed envelope for POST /alerts/{alert_id}/acknowledge.

object
data
required

Response body after acknowledging a compliance alert.

Attributes: alert_id: The acknowledged alert’s identifier. acknowledged: Whether the acknowledgement succeeded. detail: Additional details about the alert state.

object
acknowledged
required

Whether acknowledgement succeeded

boolean
alert_id
required

The acknowledged alert ID

string
detail
Any of:
object
key
additional properties
any
meta
required

Standard metadata attached to every API response.

object
request_id
required

Unique request identifier

string
timestamp
required

Server timestamp of the response

string format: date-time

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string