Query Proposed Ids Security Policy Rules

Query rules for proposed IDS security policy

Retrieves a paginated list of rules for a specific proposed IDS security policy. Rules are always returned ordered by sequence number ascending. Filtering and sorting parameters in the request body are not applied.

Request

URI

POST

https://{api_host}/ssp/segmentation/{session-id}/results/proposed-ids-security-policies/{policy-id}/rules

COPY

Path Parameters

string

session-id

Required

Unique identifier of the segmentation session.

string

policy-id

Required

Unique identifier of the proposed IDS security policy.

Request Body

Pagination parameters. Only offset and page_size are applied; filtering and sort parameters are accepted but ignored - rules are always returned ordered by sequence number ascending.

ProposedIdsSecurityPolicyRulesRequest of type(s) application/json

Required

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

{
    "offset": 0,
    "page_size": 2,
    "sort_ascending": true
}

Authentication

This operation uses the following authentication methods.

Responses

200

Successfully retrieved rules

Returns ProposedIdsSecurityPolicyRulesListResponse of type(s) application/json

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

{
    "offset": 0,
    "number_of_results": 2,
    "total_result_count": 15,
    "total_pages": 8,
    "sort_ascending": true,
    "sort_by": "sequenceNumber",
    "results": [
        {
            "id": "SSP_Infra_IDPS_DNS_Rule_b3feb714-e6b4-3395-bd70-2d2edd9f058a",
            "display_name": "SSP_US_AZ1_DNS",
            "description": "IDPS SSP_US_AZ1_DNS",
            "action": "DETECT",
            "disabled": false,
            "proposed_sync_action": "CREATE",
            "nsx_rule": {
                "resource_type": "IdsRule",
                "id": "SSP_Infra_IDPS_DNS_Rule_b3feb714-e6b4-3395-bd70-2d2edd9f058a",
                "sequence_number": 1100,
                "source_groups": [
                    "/infra/domains/default/groups/0c2fe03b-5916-3d87-a969-5a6be090e3ab"
                ],
                "destination_groups": [
                    "/infra/domains/default/groups/b3feb714-e6b4-3395-bd70-2d2edd9f058a"
                ],
                "action": "DETECT",
                "ids_profiles": [
                    "/infra/settings/firewall/security/intrusion-services/profiles/SSP_Infra_IDPS_Profile"
                ],
                "services": [
                    "/infra/services/DNS"
                ]
            }
        },
        {
            "id": "SSP_Infra_IDPS_DNS_Rule",
            "display_name": "SSP_DNS",
            "description": "IDPS SSP_DNS",
            "action": "DETECT",
            "disabled": false,
            "proposed_sync_action": "CREATE",
            "nsx_rule": {
                "resource_type": "IdsRule",
                "id": "SSP_Infra_IDPS_DNS_Rule",
                "sequence_number": 1200,
                "source_groups": [
                    "ANY"
                ],
                "destination_groups": [
                    "/infra/domains/default/groups/508a0fae-a70c-3049-a40f-b97113e32b4f"
                ],
                "action": "DETECT",
                "ids_profiles": [
                    "/infra/settings/firewall/security/intrusion-services/profiles/SSP_Infra_IDPS_Profile"
                ],
                "services": [
                    "/infra/services/DNS"
                ]
            }
        }
    ]
}

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

Unexpected 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}/ssp/segmentation/{session-id}/results/proposed-ids-security-policies/{policy-id}/rules

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Policy Onboarding Operations

POST

Query Proposed Security Policies