Vigilbase One APIReports

Get a monthly security report

One monthly security report with its sections. Billing appears only for readers with billing access, and never for a customer billed through a partner.

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

GET/customers/{customerId}/recon-reports/{reportId}

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

Path Parameters

customerIdstringuuidrequired

reportIdstringuuidrequired

Response

application/json

Success

idstringuuidrequired

customerIdstringuuidrequired

customerNamestring | nullrequired

periodobjectrequired

4 child attributes

startstringrequired

endstringrequired

labelstringrequired

typestringrequired

statusstringrequired

One of:pendinggeneratingcompletedfailed

generatedAtanyrequired

availableSectionsstring[]required

brandingobjectrequired

5 child attributes

typestringrequired

One of:vigilbasepartner

partnerNamestring | nullrequired

partnerLogoUrlstring | nullrequired

customerLogoUrlstring | nullrequired

accentColorstringrequired

publicLinkanyrequired

Whether a public share link exists. The link itself is a bearer URL and is not returned.

executiveSummaryobjectrequired

6 child attributes

overallScorenumberrequired

Score from 0 to 100. 0 when scored is false.

scoreLabelstringrequired

Excellent, Good, Fair or Needs Attention; "Not scored" when scored is false.

scoredbooleanrequired

False when no service could be measured for the report, so overallScore carries no meaning.

scoreVersionanyrequired

2 for the security score (Cloudflare Checkup and endpoint protection). Null for older reports, whose health score also counted support and cache performance and defaulted to 75 without data. Compare scores only within one version.

highlightsstring[]required

serviceSummaryobjectrequired

threatLandscapeobjectrequired

5 child attributes

titlestringrequired

summarystringrequired

keyThreatsobject[]required

4 child attributes

namestringrequired

descriptionstringrequired

severitystringrequired

One of:criticalhighmediumlow

affectedSystemsstring[]required

industryAlertsobject[]required

4 child attributes

industrystringrequired

titlestringrequired

descriptionstringrequired

severitystringrequired

One of:criticalhighmediumlow

recommendationsobject[]required

4 child attributes

titlestringrequired

descriptionstringrequired

prioritystringrequired

One of:highmediumlow

categorystringrequired

insightsobject[]required

9 child attributes

typestringrequired

One of:anomalytrendrecommendationhighlight

severitystringrequired

One of:infowarningcriticalsuccess

titlestringrequired

descriptionstringrequired

servicestring | nullrequired

metricstring | nullrequired

valuenumber | nullrequired

previousValuenumber | nullrequired

isIncreaseBetterbooleanrequired

aiAnalysisanyrequired

comparisonobjectrequired

7 child attributes

endpointChangePctnumber | nullrequired

threatsChangePctnumber | nullrequired

requestsChangePctnumber | nullrequired

bandwidthChangePctnumber | nullrequired

cacheHitChangePctnumber | nullrequired

supportTicketsChangePctnumber | nullrequired

securityThreatsChangePctnumber | nullrequired

endpointobjectrequired

2 child attributes

ninjaOneanyrequired

huntressanyrequired

backupobjectrequired

1 child attribute

afianyrequired

cloudflareobjectrequired

3 child attributes

metricsobjectrequired

Traffic, cache, security and product figures for the period, as the report page shows them.

zonesobject[]required

7 child attributes

zoneIdstringrequired

zoneNamestringrequired

statusstringrequired

requestsnumberrequired

bandwidthnumberrequired

cacheHitRationumberrequired

threatsnumberrequired

configurationanyrequired

The Cloudflare configuration review (checkup grades and findings), when the report has one.

supportobjectrequired

6 child attributes

issuesCreatednumberrequired

issuesClosednumberrequired

openIssuesnumberrequired

averageResolutionTimeHoursnumber | nullrequired

issuesByPriorityobjectrequired

4 child attributes

urgentnumberrequired

highnumberrequired

mediumnumberrequired

lownumberrequired

slaCompliancePercentnumber | nullrequired

billinganyrequired

Present only when the report has a billing section the caller may see; null for readers without billing access and for customers billed through a partner.

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}/recon-reports/{reportId}' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN"

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

{
  "id": "<uuid>",
  "customerId": "<uuid>",
  "customerName": "<string>",
  "period": {
    "start": "<string>",
    "end": "<string>",
    "label": "<string>",
    "type": "<string>"
  },
  "status": "pending",
  "generatedAt": "<any>",
  "availableSections": [
    "threat_landscape"
  ],
  "branding": {
    "type": "vigilbase",
    "partnerName": "<string>",
    "partnerLogoUrl": "<string>",
    "customerLogoUrl": "<string>",
    "accentColor": "<string>"
  },
  "publicLink": "<any>",
  "executiveSummary": {
    "overallScore": 123,
    "scoreLabel": "<string>",
    "scored": true,
    "scoreVersion": "<any>",
    "highlights": [
      "<string>"
    ],
    "serviceSummary": {}
  },
  "threatLandscape": {
    "title": "<string>",
    "summary": "<string>",
    "keyThreats": [
      {
        "name": "<string>",
        "description": "<string>",
        "severity": "critical",
        "affectedSystems": [
          "<string>"
        ]
      }
    ],
    "industryAlerts": [
      {
        "industry": "<string>",
        "title": "<string>",
        "description": "<string>",
        "severity": "critical"
      }
    ],
    "recommendations": [
      {
        "title": "<string>",
        "description": "<string>",
        "priority": "high",
        "category": "<string>"
      }
    ]
  },
  "insights": [
    {
      "type": "anomaly",
      "severity": "info",
      "title": "<string>",
      "description": "<string>",
      "service": "<string>",
      "metric": "<string>",
      "value": 123,
      "previousValue": 123,
      "isIncreaseBetter": true
    }
  ],
  "aiAnalysis": "<any>",
  "comparison": {
    "endpointChangePct": 123,
    "threatsChangePct": 123,
    "requestsChangePct": 123,
    "bandwidthChangePct": 123,
    "cacheHitChangePct": 123,
    "supportTicketsChangePct": 123,
    "securityThreatsChangePct": 123
  },
  "endpoint": {
    "ninjaOne": "<any>",
    "huntress": "<any>"
  },
  "backup": {
    "afi": "<any>"
  },
  "cloudflare": {
    "metrics": {},
    "zones": [
      {
        "zoneId": "<string>",
        "zoneName": "<string>",
        "status": "<string>",
        "requests": 123,
        "bandwidth": 123,
        "cacheHitRatio": 123,
        "threats": 123
      }
    ],
    "configuration": "<any>"
  },
  "support": {
    "issuesCreated": 123,
    "issuesClosed": 123,
    "openIssues": 123,
    "averageResolutionTimeHours": 123,
    "issuesByPriority": {
      "urgent": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    },
    "slaCompliancePercent": 123
  },
  "billing": "<any>"
}

Was this page helpful?