Vigilbase One APICustomers

Acknowledge a monitoring incident

"I've got this" on an incident, recorded for everyone. incidentId is the incident key, or any of its event ids. The first acknowledgement wins; a repeat returns it with created: false.

Deprecated aliases: POST https://one.vigilbase.com/api/customers/{id}/incidents/{incidentId}/acknowledge. They answer with the same bodies, with a Deprecation header and a successor-version link to this URL.

POST/customers/{customerId}/incidents/{incidentId}/acknowledge

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login. Scope: one:api.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

Vigilbase Identity access token issued to an MCP client (mcp.vigilbase.com). Scope: one:write.

Permissions checkedread:customers

Path Parameters

customerIdstringuuidrequired

incidentIdstringuuidrequired

Headers

Idempotency-Keystring

A unique key for this write (a UUID is recommended). A retry with the same key and body returns the first answer (draft-ietf-httpapi-idempotency-key-header-08).

min length 1max length 255

Body

application/json

notestring

max length 500

Response

application/json

Success

incidentKeystringuuidrequired

acknowledgementobjectrequired

4 child attributes

byNamestring | nullrequired

byEmailstring | nullrequired

atstringdate-timerequired

notestring | nullrequired

createdbooleanrequired

False when the incident was already acknowledged; that acknowledgement is returned.

2 response headers

X-Request-Idstring

The request ID: yours when it was well-formed, otherwise a new one. Quote it to support.

API-Versionstring

The major API version (informational; the version is in the path).

More about this endpoint in the guide.

# Token from `vigilbase login`, or a write API key (vb_one_…)
curl --request POST \
  --url 'https://api.vigilbase.com/one/v1/customers/{customerId}/incidents/{incidentId}/acknowledge' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"note":"<string>"}'

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

{
  "incidentKey": "<uuid>",
  "acknowledgement": {
    "byName": "<string>",
    "byEmail": "<string>",
    "at": "<string>",
    "note": "<string>"
  },
  "created": true
}

Was this page helpful?