Add a Watchdog target

Starts uptime checks and security scans of a website for a customer. A customer can have each domain once.

Deprecated aliases: POST 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.

POST/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_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

AuthorizationstringMCP tokenheaderrequired

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

Permissions checkedwrite:monitoringwrite:partner_services

Path Parameters

customerIdstringuuidrequired

Headers

Idempotency-Keystring

A unique key for this write (a UUID is recommended). A retry with the same key and body returns the first answer (draft-ietf-httpapi-idempotency-key-header-08).

min length 1max length 255

Body

application/json

domainstringrequired

A public hostname; private and reserved names are refused.

min length 1max length 255

displayNamestring

max length 255

targetUrlstring

Defaults to https://{domain}.

max length 2048

uptimeEnabledboolean

Default:true

securityEnabledboolean

Default:true

checkTypestring

One of:httphttpstcpdnsicmpDefault:"https"

checkIntervalSecondsinteger

Default:60minimum 30maximum 3600

timeoutSecondsinteger

Default:10minimum 5maximum 60

regionsstring[]

Defaults to the offered ones of nyc, lon and sgp.

max 50 items

latencyWarningMsinteger

Default:2000minimum 100maximum 30000

latencyCriticalMsinteger

Default:5000minimum 100maximum 60000

scanFrequencystring

One of:hourlydailyweeklyDefault:"daily"

Response

application/json

Success

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

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 a write API key (vb_one_…)
curl --request POST \
  --url 'https://api.vigilbase.com/one/v1/customers/{customerId}/watchdog-targets' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"domain":"<string>","displayName":"<string>","targetUrl":"<string>","uptimeEnabled":true,"securityEnabled":true,"checkType":"https","checkIntervalSeconds":60,"timeoutSeconds":10,"regions":["<string>"],"latencyWarningMs":2000,"latencyCriticalMs":5000,"scanFrequency":"daily"}'

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

{
  "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>"
}

Was this page helpful?