Who is shown as having acknowledged the incident?

An API key isn't tied to a person, so the incident's activity shows it was acknowledged through the API.

Do I need to send X-API-KEY exactly, or can I use another header name?

Send X-API-KEY . This endpoint doesn't accept other header names for the key.

Acknowledge an Incident

Acknowledge an incident from your own system, for example when an automated remediation starts working on it. The incident moves to Acknowledged, the same as when a responder acknowledges it in Oppex.

Request

POST https://api.oppex.ai/api/v1/incident/acknowledge?incidentID=<incident-id>

There is no request body. Send the incident id as the incidentID query parameter, and your API key in the X-API-KEY header.

curl -X POST "https://api.oppex.ai/api/v1/incident/acknowledge?incidentID=8GFB1ADE-1M3C-KJ2QX7PA" \
  -H "X-API-KEY: <your-api-key>"

The incident id is the data value returned by Post an Incident. You can also find it with List Incidents.

Response

{
  "success": true,
  "statusCode": 200,
  "message": "Incident acknowledged successfully",
  "data": "8GFB1ADE-1M3C-KJ2QX7PA"
}

A 200 means Oppex accepted the request. The incident is acknowledged a moment later. To confirm it, check the incident's status with List Incidents.

Errors

Status	When
`400`	`incidentID` is missing.
`401`	The API key is missing, wrong or disabled. See API Keys.
`500`	Something went wrong in Oppex. Retry. If it keeps happening, contact support with the `message`.

Request​

Response​

Errors​

Request

Response

Errors