Query Proposed Security Policies

Query proposed security policies

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

Notes

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

Request

URI

POST

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

COPY

Path Parameters

string

session-id

Required

Unique identifier of the segmentation session.

Request Body

Query parameters for filtering, sorting, and pagination

ProposedSecurityPoliciesRequest of type(s) application/json

Required

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

{
    "filter_by_infrastructure": {
        "summary": "Query all INFRASTRUCTURE 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 security policies

Returns ProposedSecurityPoliciesListResponse of type(s) application/json

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

{
    "success": {
        "summary": "Successfully retrieved INFRASTRUCTURE policies",
        "value": {
            "offset": 0,
            "number_of_results": 2,
            "total_result_count": 2,
            "total_pages": 1,
            "sort_ascending": true,
            "sort_by": "sequenceNumber",
            "results": [
                {
                    "id": "250f9f29-d983-3bab-9ed1-1bc61c21010a",
                    "display_name": "SSP_Infra_Custom",
                    "description": "SSP created policy for SSP_Infra_Custom_Policy",
                    "policy_type": "INFRASTRUCTURE",
                    "publish_status": "READY_TO_PUBLISH",
                    "publish_action": "NONE",
                    "rule_count": 2
                },
                {
                    "id": "206e2e21-e1f8-36d4-9195-bc1365ac1d40",
                    "display_name": "SSP_Infra",
                    "description": "SSP created policy for SSP_Infra_Policy",
                    "policy_type": "INFRASTRUCTURE",
                    "publish_status": "READY_TO_PUBLISH",
                    "publish_action": "NONE",
                    "rule_count": 21
                }
            ]
        }
    }
}

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-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