Vigilbase One APICloudflare

Get Cloudflare Checkup status

The Cloudflare account the checkup covers, its latest completed run and any run in progress. accountId picks one of several linked accounts. Staff must name the customer with customerId; everyone else gets their own organisation’s customer.

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

GET/cloudflare/checkups

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

Query Parameters

customerIdstringuuid

accountIdstring

A Cloudflare ID: 32 lower-case hexadecimal characters.

pattern ^[a-f0-9]{32}$

Response

application/json

Success

requiresSetupbooleanrequired

True when no Cloudflare account with checkups is connected.

accountanyrequired

credentialSourcestring | nullrequired

Whose Cloudflare credentials the checkup uses: default, customer or partner.

latestRunanyrequired

The latest completed checkup; GET /tool-runs/{runId} has its results.

activeRunanyrequired

lastValidatedAtanyrequired

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/cloudflare/checkups' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "requiresSetup": true,
  "account": "<any>",
  "credentialSource": "<string>",
  "latestRun": "<any>",
  "activeRun": "<any>",
  "lastValidatedAt": "<any>"
}

Was this page helpful?