Skip to content
Cloudflare API
Start here
API Reference
Security Center
Insights
Severity

Retrieves Security Center Insight Counts by Severity

client.securityCenter.insights.severity.get(SeverityGetParams { account_id, zone_id, dismissed, 10 more } params?, RequestOptionsoptions?): SeverityGetResponse { count, value }
GET/{accounts_or_zones}/{account_or_zone_id}/security-center/insights/severity

Retrieves Security Center insight counts aggregated by severity level (critical, high, medium, low).

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
params: SeverityGetParams { account_id, zone_id, dismissed, 10 more }
account_id?: string

Path param: The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: string

Path param: The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

dismissed?: boolean

Query param

issue_class?: Array<string>

Query param

issueClassNeq?: Array<string>

Query param

issue_type?: Array<IssueType>

Query param

One of the following:
"compliance_violation"
"email_security"
"exposed_infrastructure"
"insecure_configuration"
"weak_authentication"
"configuration_suggestion"
issueTypeNeq?: Array<IssueType>

Query param

One of the following:
"compliance_violation"
"email_security"
"exposed_infrastructure"
"insecure_configuration"
"weak_authentication"
"configuration_suggestion"
product?: Array<string>

Query param

productNeq?: Array<string>

Query param

severity?: Array<SeverityQueryParam>

Query param

One of the following:
"low"
"moderate"
"critical"
severityNeq?: Array<SeverityQueryParam>

Query param

One of the following:
"low"
"moderate"
"critical"
subject?: Array<string>

Query param

subjectNeq?: Array<string>

Query param

ReturnsExpand Collapse
SeverityGetResponse = Array<SeverityGetResponseItem>
count?: number
value?: string

Retrieves Security Center Insight Counts by Severity

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const severities = await client.securityCenter.insights.severity.get({ account_id: 'account_id' });

console.log(severities);
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "count": 1,
      "value": "value"
    }
  ]
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "count": 1,
      "value": "value"
    }
  ]
}