List Watchdog targets

The websites Watchdog checks for a customer, newest first, with their last observed status.

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

GET/customers/{customerId}/watchdog-targets

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:monitoringread:partner_monitoring

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

22 child attributes

idstringuuidrequired

domainstringrequired

displayNamestring | nullrequired

targetUrlstring | nullrequired

checkTypestringrequired

checkIntervalSecondsintegerrequired

minimum -9007199254740991maximum 9007199254740991

timeoutSecondsintegerrequired

minimum -9007199254740991maximum 9007199254740991

regionsstring[]required

uptimeEnabledbooleanrequired

securityEnabledbooleanrequired

alertingEnabledboolean | nullrequired

scanFrequencystring | nullrequired

hourly, daily or weekly.

latencyWarningMsanyrequired

latencyCriticalMsanyrequired

sourcestring | nullrequired

manual, cloudflare, import, api, …

latestGradestring | nullrequired

latestScorenumber | nullrequired

lastScanAtanyrequired

nextScanAtanyrequired

statusobjectrequired

8 child attributes

isUpboolean | nullrequired

Null when the last check is stale or unknown.

lastCheckAtanyrequired

uptime24hnumber | nullrequired

uptime7dnumber | nullrequired

uptime30dnumber | nullrequired

avgLatencyMsnumber | nullrequired

sslDaysUntilExpirynumber | nullrequired

sslExpiryDateanyrequired

createdAtanyrequired

updatedAtanyrequired

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

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

{
  "items": [
    {
      "id": "<uuid>",
      "domain": "<string>",
      "displayName": "<string>",
      "targetUrl": "<string>",
      "checkType": "<string>",
      "checkIntervalSeconds": 123,
      "timeoutSeconds": 123,
      "regions": [
        "<string>"
      ],
      "uptimeEnabled": true,
      "securityEnabled": true,
      "alertingEnabled": true,
      "scanFrequency": "<string>",
      "latencyWarningMs": "<any>",
      "latencyCriticalMs": "<any>",
      "source": "<string>",
      "latestGrade": "<string>",
      "latestScore": 123,
      "lastScanAt": "<any>",
      "nextScanAt": "<any>",
      "status": {
        "isUp": true,
        "lastCheckAt": "<any>",
        "uptime24h": 123,
        "uptime7d": 123,
        "uptime30d": 123,
        "avgLatencyMs": 123,
        "sslDaysUntilExpiry": 123,
        "sslExpiryDate": "<any>"
      },
      "createdAt": "<any>",
      "updatedAt": "<any>"
    }
  ],
  "nextCursor": "<string>"
}

Was this page helpful?