List Anomaly Rule Sets

Returns the list of anomaly rule-sets from the firewall rule analysis activity result.

After the rule analysis activity is complete, it returns the various anomaly rule-sets that were found during the analysis. Each of this anomaly rule-set has a list of firewall rules that have the anomaly.

Request

URI

POST

https://{api_host}/firewall/rule-analysis/activities/{id}/result/anomaly-rule-sets/action/query

COPY

Path Parameters

string

Required

ID of rule analysis activity

Request Body

Use the parameters to list the firewall rule analysis anomaly rule-sets.

AnomalyRuleSetsListRequest of type(s) application/json

Optional

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

{
    "site_ids": [
        "string"
    ],
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "rule_name": [
        "string"
    ],
    "rule_id": [
        0
    ],
    "anomaly_type": [
        "string"
    ],
    "policy_path": [
        "string"
    ],
    "policy_name": [
        "string"
    ]
}

Authentication

This operation uses the following authentication methods.

Responses

200

Returns AnomalyRuleSetsListResult of type(s) application/json

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

{
    "offset": 0,
    "number_of_results": 0,
    "total_result_count": 0,
    "total_pages": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "rule_sets": [
        {
            "id": "string",
            "display_name": "string",
            "anomaly_type": "string",
            "rule_count": 0
        }
    ]
}

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/{id}/result/anomaly-rule-sets/action/query

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Rule Analysis Operations

POST

Create Rule Analysis Activity