List Rule Analysis Activities

List all firewall rule analysis activities.

Retrieves a list of firewall rule analysis activities with optional filtering parameters.

Request

URI

POST

https://{api_host}/firewall/rule-analysis/activities/action/query

COPY

Request Body

Request parameters to list firewall rule analysis activities.

ActivitiesListRequest of type(s) application/json

Optional

This request body class requires all of the following: ListRequestParameters , InlineActivitiesListRequest1

{
    "site_ids": [
        "string"
    ],
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "display_name": [
        "string"
    ],
    "id": [
        "string"
    ],
    "activity_type": [
        "string"
    ],
    "status": [
        "string"
    ]
}

Authentication

This operation uses the following authentication methods.

Responses

200

Firewall rule analysis activities successful list response.

Returns ActivitiesListResult of type(s) application/json

This response body class contains all of the following: ListResult

{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "activities": [
        {
            "_create_user": "string",
            "_create_time": 0,
            "_last_modified_user": "string",
            "_last_modified_time": 0,
            "_revision": 0,
            "_resource_type": "string",
            "_system_owned": false,
            "id": "string",
            "display_name": "string",
            "description": "string",
            "site_ids": [
                "string"
            ],
            "activity_type": "string",
            "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/activities/action/query

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Rule Analysis Operations

POST

Create Rule Analysis Activity

POST