Vigilbase One APICloudflare

Get a zone’s security settings

The zone’s security defaults, read live from Cloudflare and graded by the Cloudflare Checkup’s checks; a setting Cloudflare could not answer comes from the latest checkup.

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

GET/cloudflare/zones/{zoneId}/security

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

Path Parameters

zoneIdstringrequired

A Cloudflare ID: 32 lower-case hexadecimal characters.

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

Query Parameters

customerIdstringuuidrequired

Response

application/json

Success

zoneIdstringrequired

sourceanyrequired

readAtanyrequired

liveErrorstring | nullrequired

Why Cloudflare could not be read live; settings then come from the latest checkup.

checkupanyrequired

settingsobjectrequired

8 child attributes

sslobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

wafobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

browserCheckobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

challengeTtlobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

securityLevelobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

opportunisticEncryptionobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

automaticHttpsRewritesobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

alwaysUseHttpsobjectrequired

6 child attributes

enabledboolean | nullrequired

Pass is true, warning or fail is false; null when not graded or not read.

statusanyrequired

detailsstringrequired

sourceanyrequired

valuestring | number | boolean | nullrequired

The Cloudflare setting value (live reads only).

checkedAtanyrequired

defaultsobjectrequired

2 child attributes

appliedboolean | nullrequired

Whether the zone has every recommended default (live values only).

pendingstring[]required

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/zones/{zoneId}/security?customerId={customerId}' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "zoneId": "<string>",
  "source": "<any>",
  "readAt": "<any>",
  "liveError": "<string>",
  "checkup": "<any>",
  "settings": {
    "ssl": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "waf": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "browserCheck": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "challengeTtl": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "securityLevel": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "opportunisticEncryption": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "automaticHttpsRewrites": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    },
    "alwaysUseHttps": {
      "enabled": true,
      "status": "<any>",
      "details": "<string>",
      "source": "<any>",
      "value": "<string>",
      "checkedAt": "<any>"
    }
  },
  "defaults": {
    "applied": true,
    "pending": [
      "ssl"
    ]
  }
}

Was this page helpful?