Vigilbase One APIMonitoring

Start a Watchdog scan

Queues a security scan of one target. Only one scan per target runs at a time (409 otherwise). The target must have security scanning on.

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

POST/customers/{customerId}/watchdog-scans

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

operationIdstringuuidrequired

A UUID you choose. Retrying with the same one never starts a second scan; it becomes the scan ID.

targetIdstringuuidrequired

scanTypestring

One of:fullquickDefault:"full"

Response

application/json

Success

operationIdstringuuidrequired

scanIdstringuuidrequired

statusstringrequired

queued

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-scans' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"operationId":"<uuid>","targetId":"<uuid>","scanType":"full"}'

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

{
  "operationId": "<uuid>",
  "scanId": "<uuid>",
  "status": "<string>"
}

Was this page helpful?