List contract usage alerts

Active contract line items whose usage is near or over the contracted limit, over-limit first.

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

GET/customers/{customerId}/usage-alerts

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:contracts

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

Response

application/json

Success

itemsobject[]required

6 child attributes

contractIdstringuuidrequired

contractNamestringrequired

serviceNamestringrequired

serviceTypestringrequired

Integration tool, e.g. cloudflare, ninja-one.

usagePercentagenumberrequired

statusstringrequired

One of:warningcriticalover_limit

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}/usage-alerts' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "items": [
    {
      "contractId": "<uuid>",
      "contractName": "<string>",
      "serviceName": "<string>",
      "serviceType": "<string>",
      "usagePercentage": 123,
      "status": "warning"
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?