List Rule Analysis Summaries

List firewall rule analysis summary.

Returns the list of firewall rule analysis summary on local managers.

Request

URI

POST

https://{api_host}/firewall/rule-analysis/summaries

COPY

Request Body

Use the parameters to list the firewall rule analysis summaries.

FirewallRuleAnalysisSummaryListRequest of type(s) application/json

Optional

This request body class requires all of the following: ListRequestParameters

{
    "site_ids": [
        "string"
    ],
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string"
}

Authentication

This operation uses the following authentication methods.

Responses

200

Returns FirewallRuleAnalysisSummaryListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineFirewallRuleAnalysisSummaryListResult1

{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "rule_analysis_summary": [
        {
            "rule_analysis_activity_in_progress": false,
            "in_progress_activity_id": "string",
            "next_auto_rule_analysis_start_time": 0,
            "auto_rule_analysis_approx_time_estimate_mins": 0,
            "total_rule_analysis_activities": 0,
            "latest_active_config_analysis_activity_summary": {
                "status": "string",
                "start_time": 0,
                "end_time": 0,
                "progress": 0,
                "cancelable": false,
                "is_stale": false,
                "is_last_successful": false,
                "cancelled_by": "string",
                "cancellation_time": 0,
                "anomalies_summary": [
                    {
                        "anomaly_type": "string",
                        "count": 0
                    }
                ],
                "rules_analyzed_count": 0,
                "rules_ignored_count": 0,
                "failure_reason": "string"
            },
            "latest_what_if_analysis_activity_summary": {
                "status": "string",
                "start_time": 0,
                "end_time": 0,
                "progress": 0,
                "cancelable": false,
                "is_stale": false,
                "is_last_successful": false,
                "cancelled_by": "string",
                "cancellation_time": 0,
                "anomalies_summary": [
                    {
                        "anomaly_type": "string",
                        "count": 0
                    }
                ],
                "rules_analyzed_count": 0,
                "rules_ignored_count": 0,
                "failure_reason": "string"
            }
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

Error

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/firewall/rule-analysis/summaries

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Rule Analysis Operations

POST

Create Rule Analysis Activity

POST