Query Proposed Ids Security Policies

Query proposed IDS security policies

Retrieves a paginated list of proposed IDS security policies generated during segmentation analysis.

Notes

IDS security policies represent proposed NSX IDS security policies that can be published.
Returns 200 on success

Request

URI

POST

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

COPY

Path Parameters

string

session-id

Required

Unique identifier of the segmentation session.

Request Body

Query parameters for filtering, sorting, and pagination

ProposedIdsSecurityPoliciesRequest of type(s) application/json

Required

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

{
    "filter_by_infrastructure": {
        "summary": "Query all INFRASTRUCTURE IDS policies",
        "value": {
            "policy_type": "INFRASTRUCTURE",
            "sort_ascending": true,
            "page_size": 50,
            "offset": 0
        }
    }
}

Authentication

This operation uses the following authentication methods.

Responses

200

Successfully retrieved proposed IDS security policies

Returns ProposedIdsSecurityPoliciesListResponse of type(s) application/json

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

{
    "offset": 0,
    "number_of_results": 2,
    "total_result_count": 2,
    "total_pages": 1,
    "sort_ascending": true,
    "sort_by": "sequenceNumber",
    "results": [
        {
            "id": "f94a73ae-d5a0-39f3-b551-252bff2c5419",
            "display_name": "SSP_Infra_Custom_IDPS",
            "description": "IDPS Policy for custom infrastructure services",
            "policy_type": "INFRASTRUCTURE",
            "publish_status": "READY_TO_PUBLISH",
            "publish_action": "NONE",
            "rule_count": 2
        },
        {
            "id": "f15c59a9-00f7-38f9-87b4-b866bb6083f3",
            "display_name": "SSP_Infra_IDPS",
            "description": "IDPS Policy for all infrastructure services",
            "policy_type": "INFRASTRUCTURE",
            "publish_status": "READY_TO_PUBLISH",
            "publish_action": "NONE",
            "rule_count": 20
        }
    ]
}

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Policy Onboarding Operations

POST

Query Proposed Security Policies