Vigilbase One APIMonitoring

Get target metrics

Live uptime, latency and certificate metrics for 1–50 targets (repeat targetIds). Every target must belong to a customer the caller can read, or the whole request is refused.

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

GET/monitoring/metrics

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

Query Parameters

targetIdsstring[]required

min 1 itemsmax 50 items

Response

application/json

Success

metricsobject[]required

4 child attributes

targetIdstringuuidrequired

uptimeanyrequired

latencyanyrequired

sslanyrequired

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/monitoring/metrics?targetIds={targetIds}' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "metrics": [
    {
      "targetId": "<uuid>",
      "uptime": "<any>",
      "latency": "<any>",
      "ssl": "<any>"
    }
  ]
}

Was this page helpful?