# Insights ## Retrieves Security Center Insights `security_center.insights.list(InsightListParams**kwargs) -> SyncV4PagePagination[Optional[InsightListResponse]]` **get** `/{accounts_or_zones}/{account_or_zone_id}/security-center/insights` Lists all Security Center insights for the account or zone, showing security findings and recommendations. ### Parameters - `account_id: Optional[str]` The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `zone_id: Optional[str]` The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. - `dismissed: Optional[bool]` - `issue_class: Optional[SequenceNotStr[str]]` - `issue_class_neq: Optional[SequenceNotStr[str]]` - `issue_type: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `issue_type_neq: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `page: Optional[int]` Specifies the current page within paginated list of results. - `per_page: Optional[int]` Sets the number of results per page of results. - `product: Optional[SequenceNotStr[str]]` - `product_neq: Optional[SequenceNotStr[str]]` - `severity: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `severity_neq: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `subject: Optional[SequenceNotStr[str]]` - `subject_neq: Optional[SequenceNotStr[str]]` ### Returns - `class InsightListResponse: …` - `count: Optional[int]` Indicates the total number of results. - `issues: Optional[List[Issue]]` - `id: Optional[str]` - `dismissed: Optional[bool]` - `issue_class: Optional[str]` - `issue_type: Optional[IssueType]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `payload: Optional[IssuePayload]` - `detection_method: Optional[str]` Describes the method used to detect insight. - `zone_tag: Optional[str]` - `resolve_link: Optional[str]` - `resolve_text: Optional[str]` - `severity: Optional[Literal["Low", "Moderate", "Critical"]]` - `"Low"` - `"Moderate"` - `"Critical"` - `since: Optional[datetime]` - `subject: Optional[str]` - `timestamp: Optional[datetime]` - `page: Optional[int]` Specifies the current page within paginated list of results. - `per_page: Optional[int]` Sets the number of results per page of results. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.security_center.insights.list( account_id="account_id", ) page = page.result.items[0] print(page.count) ``` #### Response ```json { "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, "issues": [ { "id": "id", "dismissed": false, "issue_class": "always_use_https_not_enabled", "issue_type": "compliance_violation", "payload": { "detection_method": "We detected security rules referencing multiple IP addresses directly in the rules.", "zone_tag": "zone_tag" }, "resolve_link": "resolve_link", "resolve_text": "resolve_text", "severity": "Low", "since": "2019-12-27T18:11:19.117Z", "subject": "example.com", "timestamp": "2019-12-27T18:11:19.117Z" } ], "page": 1, "per_page": 25 } } ``` ## Archives Security Center Insight `security_center.insights.dismiss(strissue_id, InsightDismissParams**kwargs) -> InsightDismissResponse` **put** `/{accounts_or_zones}/{account_or_zone_id}/security-center/insights/{issue_id}/dismiss` Archives a Security Center insight for an account or zone, removing it from the active insights list while preserving historical data. ### Parameters - `issue_id: str` - `account_id: Optional[str]` The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `zone_id: Optional[str]` The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. - `dismiss: Optional[bool]` ### Returns - `class InsightDismissResponse: …` - `errors: List[Error]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[ErrorSource]` - `pointer: Optional[str]` - `messages: List[Message]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[MessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) response = client.security_center.insights.dismiss( issue_id="issue_id", account_id="account_id", ) print(response.errors) ``` #### Response ```json { "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 } ``` ## Domain Types ### Insight List Response - `class InsightListResponse: …` - `count: Optional[int]` Indicates the total number of results. - `issues: Optional[List[Issue]]` - `id: Optional[str]` - `dismissed: Optional[bool]` - `issue_class: Optional[str]` - `issue_type: Optional[IssueType]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `payload: Optional[IssuePayload]` - `detection_method: Optional[str]` Describes the method used to detect insight. - `zone_tag: Optional[str]` - `resolve_link: Optional[str]` - `resolve_text: Optional[str]` - `severity: Optional[Literal["Low", "Moderate", "Critical"]]` - `"Low"` - `"Moderate"` - `"Critical"` - `since: Optional[datetime]` - `subject: Optional[str]` - `timestamp: Optional[datetime]` - `page: Optional[int]` Specifies the current page within paginated list of results. - `per_page: Optional[int]` Sets the number of results per page of results. ### Insight Dismiss Response - `class InsightDismissResponse: …` - `errors: List[Error]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[ErrorSource]` - `pointer: Optional[str]` - `messages: List[Message]` - `code: int` - `message: str` - `documentation_url: Optional[str]` - `source: Optional[MessageSource]` - `pointer: Optional[str]` - `success: Literal[true]` Whether the API call was successful. - `true` # Class ## Retrieves Security Center Insight Counts by Class `security_center.insights.class_.get(ClassGetParams**kwargs) -> ClassGetResponse` **get** `/{accounts_or_zones}/{account_or_zone_id}/security-center/insights/class` Retrieves Security Center insight counts aggregated by classification class. ### Parameters - `account_id: Optional[str]` The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `zone_id: Optional[str]` The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. - `dismissed: Optional[bool]` - `issue_class: Optional[SequenceNotStr[str]]` - `issue_class_neq: Optional[SequenceNotStr[str]]` - `issue_type: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `issue_type_neq: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `product: Optional[SequenceNotStr[str]]` - `product_neq: Optional[SequenceNotStr[str]]` - `severity: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `severity_neq: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `subject: Optional[SequenceNotStr[str]]` - `subject_neq: Optional[SequenceNotStr[str]]` ### Returns - `List[ClassGetResponseItem]` - `count: Optional[int]` - `value: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) classes = client.security_center.insights.class_.get( account_id="account_id", ) print(classes) ``` #### Response ```json { "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" } ] } ``` ## Domain Types ### Class Get Response - `List[ClassGetResponseItem]` - `count: Optional[int]` - `value: Optional[str]` # Severity ## Retrieves Security Center Insight Counts by Severity `security_center.insights.severity.get(SeverityGetParams**kwargs) -> SeverityGetResponse` **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). ### Parameters - `account_id: Optional[str]` The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `zone_id: Optional[str]` The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. - `dismissed: Optional[bool]` - `issue_class: Optional[SequenceNotStr[str]]` - `issue_class_neq: Optional[SequenceNotStr[str]]` - `issue_type: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `issue_type_neq: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `product: Optional[SequenceNotStr[str]]` - `product_neq: Optional[SequenceNotStr[str]]` - `severity: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `severity_neq: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `subject: Optional[SequenceNotStr[str]]` - `subject_neq: Optional[SequenceNotStr[str]]` ### Returns - `List[SeverityGetResponseItem]` - `count: Optional[int]` - `value: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) severities = client.security_center.insights.severity.get( account_id="account_id", ) print(severities) ``` #### Response ```json { "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" } ] } ``` ## Domain Types ### Severity Get Response - `List[SeverityGetResponseItem]` - `count: Optional[int]` - `value: Optional[str]` # Type ## Retrieves Security Center Insight Counts by Type `security_center.insights.type.get(TypeGetParams**kwargs) -> TypeGetResponse` **get** `/{accounts_or_zones}/{account_or_zone_id}/security-center/insights/type` Retrieves Security Center insight counts aggregated by insight type. ### Parameters - `account_id: Optional[str]` The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. - `zone_id: Optional[str]` The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. - `dismissed: Optional[bool]` - `issue_class: Optional[SequenceNotStr[str]]` - `issue_class_neq: Optional[SequenceNotStr[str]]` - `issue_type: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `issue_type_neq: Optional[List[IssueType]]` - `"compliance_violation"` - `"email_security"` - `"exposed_infrastructure"` - `"insecure_configuration"` - `"weak_authentication"` - `"configuration_suggestion"` - `product: Optional[SequenceNotStr[str]]` - `product_neq: Optional[SequenceNotStr[str]]` - `severity: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `severity_neq: Optional[List[SeverityQueryParam]]` - `"low"` - `"moderate"` - `"critical"` - `subject: Optional[SequenceNotStr[str]]` - `subject_neq: Optional[SequenceNotStr[str]]` ### Returns - `List[TypeGetResponseItem]` - `count: Optional[int]` - `value: Optional[str]` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) types = client.security_center.insights.type.get( account_id="account_id", ) print(types) ``` #### Response ```json { "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" } ] } ``` ## Domain Types ### Type Get Response - `List[TypeGetResponseItem]` - `count: Optional[int]` - `value: Optional[str]`