Vigilbase One APICustomers

List a customer’s monitoring incidents

Monitoring incidents over the last windowDays (default 30), newest first, with their acknowledgements. Built from at most the 500 newest alert events in the window.

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

GET/customers/{customerId}/incidents

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_…. Read-only keys work. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

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

Permissions checkedread:customers

Path Parameters

customerIdstringuuidrequired

Query Parameters

A cursor-paginated list: the response holds items, and while it has a nextCursor, pass it as cursor for the next page. See pagination.

cursorstring

The nextCursor of the previous page. Leave it out for the first page.

max length 512

limitinteger

How many items to return per page.

Default:50maximum 200

windowDaysinteger

Days back to look, 1–90.

Default:30minimum 1maximum 90

Response

application/json

Success

itemsobject[]required

15 child attributes

keystringrequired

Stable incident key; use it to acknowledge.

monitorNamestring | nullrequired

categorystring | nullrequired

severitystringrequired

One of:warningcritical

statusstringrequired

One of:openresolved

regionstring | nullrequired

targetIdstring | nullrequired

startedAtstringdate-timerequired

resolvedAtanyrequired

startedOutsideWindowbooleanrequired

The first alert is older than the window; startedAt is the first one seen.

lastTransitionstringrequired

eventCountintegerrequired

minimum -9007199254740991maximum 9007199254740991

hadNoDatabooleanrequired

eventsobject[]required

5 child attributes

idstringuuidrequired

transitionstringrequired

Triggered, Re-Triggered, Warn, No Data, Recovered, …

titlestring | nullrequired

regionstring | nullrequired

occurredAtstringdate-timerequired

acknowledgementanyrequired

nextCursorstring

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 an API key (vb_one_…)
curl --request GET \
  --url 'https://api.vigilbase.com/one/v1/customers/{customerId}/incidents' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "items": [
    {
      "key": "<string>",
      "monitorName": "<string>",
      "category": "<string>",
      "severity": "warning",
      "status": "open",
      "region": "<string>",
      "targetId": "<string>",
      "startedAt": "<string>",
      "resolvedAt": "<any>",
      "startedOutsideWindow": true,
      "lastTransition": "<string>",
      "eventCount": 123,
      "hadNoData": true,
      "events": [
        {
          "id": "<uuid>",
          "transition": "<string>",
          "title": "<string>",
          "region": "<string>",
          "occurredAt": "<string>"
        }
      ],
      "acknowledgement": "<any>"
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?