Vigilbase One APIMonitoring

Get monitoring status

Current up/down state of every uptime-enabled target with an aggregate. light=true skips latency and certificate reads. Answers may be up to 30 seconds old.

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

GET/customers/{customerId}/monitoring/status

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

Path Parameters

customerIdstringuuidrequired

Query Parameters

lightstring

One of:truefalseDefault:"false"

Response

application/json

Success

aggregateobjectrequired

6 child attributes

totalTargetsintegerrequired

minimum -9007199254740991maximum 9007199254740991

upTargetsintegerrequired

minimum -9007199254740991maximum 9007199254740991

downTargetsintegerrequired

minimum -9007199254740991maximum 9007199254740991

unknownTargetsintegerrequired

minimum -9007199254740991maximum 9007199254740991

overallStatusstringrequired

operational, partial_outage, major_outage or unknown.

avgUptime24hnumber | nullrequired

targetsobject[]required

8 child attributes

idstringuuidrequired

namestring | nullrequired

targetUrlstring | nullrequired

checkTypestringrequired

checkIntervalSecondsintegerrequired

minimum -9007199254740991maximum 9007199254740991

regionsstring[]required

enabledbooleanrequired

statusobjectrequired

10 child attributes

isUpboolean | nullrequired

freshnessstringrequired

One of:livecachedunknown

lastCheckAtanyrequired

uptime24hnumber | nullrequired

uptime7dnumber | nullrequired

uptime30dnumber | nullrequired

avgLatencyMsnumber | nullrequired

sslDaysUntilExpirynumber | nullrequired

sslExpiryDateanyrequired

currentAlertSeveritystring | nullrequired

dataSourcestringrequired

The metrics backend that answered, or cache_only.

metricsErroranyrequired

lightbooleanrequired

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

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

{
  "aggregate": {
    "totalTargets": 123,
    "upTargets": 123,
    "downTargets": 123,
    "unknownTargets": 123,
    "overallStatus": "<string>",
    "avgUptime24h": 123
  },
  "targets": [
    {
      "id": "<uuid>",
      "name": "<string>",
      "targetUrl": "<string>",
      "checkType": "<string>",
      "checkIntervalSeconds": 123,
      "regions": [
        "<string>"
      ],
      "enabled": true,
      "status": {
        "isUp": true,
        "freshness": "live",
        "lastCheckAt": "<any>",
        "uptime24h": 123,
        "uptime7d": 123,
        "uptime30d": 123,
        "avgLatencyMs": 123,
        "sslDaysUntilExpiry": 123,
        "sslExpiryDate": "<any>",
        "currentAlertSeverity": "<string>"
      }
    }
  ],
  "dataSource": "<string>",
  "metricsError": "<any>",
  "light": true
}

Was this page helpful?