insights
Creates, updates, deletes, gets or lists an insights resource.
Overview
| Name | insights |
| Type | Resource |
| Id | cloudflare.security_center.insights |
Fields
The following fields are returned by SELECT queries:
- list_by_account
- list_by_zone
The request was successful.
| Name | Datatype | Description |
|---|---|---|
count | integer | Indicates the total number of results. |
issues | array | |
page | integer | Specifies the current page within paginated list of results. |
per_page | integer | Sets the number of results per page of results. |
The request was successful.
| Name | Datatype | Description |
|---|---|---|
count | integer | Indicates the total number of results. |
issues | array | |
page | integer | Specifies the current page within paginated list of results. |
per_page | integer | Sets the number of results per page of results. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_by_account | select | account_id | dismissed, issue_class, issue_type, product, severity, subject, issue_class~neq, issue_type~neq, product~neq, severity~neq, subject~neq, page, per_page | Lists all Security Center insights for the account or zone, showing security findings and recommendations. |
list_by_zone | select | zone_id | dismissed, issue_class, issue_type, product, severity, subject, issue_class~neq, issue_type~neq, product~neq, severity~neq, subject~neq, page, per_page | Lists all Security Center insights for the account or zone, showing security findings and recommendations. |
dismiss_by_account | replace | account_id, issue_id | Archives a Security Center insight for an account or zone, removing it from the active insights list while preserving historical data. | |
dismiss_by_zone | replace | zone_id, issue_id | Archives a Security Center insight for an account or zone, removing it from the active insights list while preserving historical data. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
account_id | string | The Cloudflare account ID. |
issue_id | string | |
zone_id | string | The Cloudflare zone ID. |
dismissed | boolean | |
issue_class | array | |
issue_class~neq | array | |
issue_type | array | |
issue_type~neq | array | |
page | integer | |
per_page | integer | |
product | array | |
product~neq | array | |
severity | array | |
severity~neq | array | |
subject | array | |
subject~neq | array |
SELECT examples
- list_by_account
- list_by_zone
Lists all Security Center insights for the account or zone, showing security findings and recommendations.
SELECT
count,
issues,
page,
per_page
FROM cloudflare.security_center.insights
WHERE account_id = '{{ account_id }}' -- required
AND dismissed = '{{ dismissed }}'
AND issue_class = '{{ issue_class }}'
AND issue_type = '{{ issue_type }}'
AND product = '{{ product }}'
AND severity = '{{ severity }}'
AND subject = '{{ subject }}'
AND issue_class~neq = '{{ issue_class~neq }}'
AND issue_type~neq = '{{ issue_type~neq }}'
AND product~neq = '{{ product~neq }}'
AND severity~neq = '{{ severity~neq }}'
AND subject~neq = '{{ subject~neq }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;
Lists all Security Center insights for the account or zone, showing security findings and recommendations.
SELECT
count,
issues,
page,
per_page
FROM cloudflare.security_center.insights
WHERE zone_id = '{{ zone_id }}' -- required
AND dismissed = '{{ dismissed }}'
AND issue_class = '{{ issue_class }}'
AND issue_type = '{{ issue_type }}'
AND product = '{{ product }}'
AND severity = '{{ severity }}'
AND subject = '{{ subject }}'
AND issue_class~neq = '{{ issue_class~neq }}'
AND issue_type~neq = '{{ issue_type~neq }}'
AND product~neq = '{{ product~neq }}'
AND severity~neq = '{{ severity~neq }}'
AND subject~neq = '{{ subject~neq }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;
REPLACE examples
- dismiss_by_account
- dismiss_by_zone
Archives a Security Center insight for an account or zone, removing it from the active insights list while preserving historical data.
REPLACE cloudflare.security_center.insights
SET
dismiss = {{ dismiss }}
WHERE
account_id = '{{ account_id }}' --required
AND issue_id = '{{ issue_id }}' --required
RETURNING
errors,
messages,
success;
Archives a Security Center insight for an account or zone, removing it from the active insights list while preserving historical data.
REPLACE cloudflare.security_center.insights
SET
dismiss = {{ dismiss }}
WHERE
zone_id = '{{ zone_id }}' --required
AND issue_id = '{{ issue_id }}' --required
RETURNING
errors,
messages,
success;