Get Proposed Security Policy Status

• Policy Onboarding

Get proposed security policy publish status

Retrieves the publish status and any error message for a specific proposed security policy without returning the full policy object.

Notes Use this for polling or monitoring security policy publish progress.

• Returns 200 on success

Request

URI

GET

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

COPY

Path Parameters

string

session-id

Required  

Unique identifier of the segmentation session.

string

policy-id

Required  

Unique identifier of the proposed security policy.

---

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

auditor

Responses

200

Hide Details

Successfully retrieved proposed security policy publish status

Returns PublishStatusInfo of type(s) application/json

{
    "publish_status": "READY_TO_PUBLISH",
    "overall_publish_status": "READY_TO_PUBLISH"
}

string

publish_status

Optional

Status of a publish operation for a proposed object.

• READY_TO_PUBLISH: Object is ready to be published
• IN_PROGRESS: Publication is currently in progress
• PUBLISH_SUCCESS: Publication completed successfully
• PUBLISH_FAILED: Publication failed with errors
• PUBLISH_CANCELED: Publication was canceled by user

Enumeration: READY_TO_PUBLISH, IN_PROGRESS, PUBLISH_SUCCESS, PUBLISH_FAILED, PUBLISH_CANCELED

string

error_message

Read-Only  

Error message if publication failed

string

overall_publish_status

Optional

Status of a publish operation for a proposed object.

• READY_TO_PUBLISH: Object is ready to be published
• IN_PROGRESS: Publication is currently in progress
• PUBLISH_SUCCESS: Publication completed successfully
• PUBLISH_FAILED: Publication failed with errors
• PUBLISH_CANCELED: Publication was canceled by user

Enumeration: READY_TO_PUBLISH, IN_PROGRESS, PUBLISH_SUCCESS, PUBLISH_FAILED, PUBLISH_CANCELED

400

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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

Hide Details

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 -H 'Authorization: <value>' https://{api_host}/ssp/segmentation/{session-id}/results/proposed-security-policies/{policy-id}/status
                

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Policy Onboarding Operations

POST

Query Proposed Security Policies

GET

Get Proposed Security Policy

PUT

Update Proposed Security Policy

DELETE

Delete Proposed Security Policy

GET

Get Proposed Security Policy Status

POST

Query Proposed Security Policy Rules

GET

Get Proposed Security Policy Rule

PUT

Update Proposed Security Policy Rule

DELETE

Delete Proposed Security Policy Rule

POST

Query Proposed Ids Security Policies

GET

Get Proposed Ids Security Policy

PUT

Update Proposed Ids Security Policy

DELETE

Delete Proposed Ids Security Policy

GET

Get Proposed Ids Security Policy Status

POST

Query Proposed Ids Security Policy Rules

GET

Get Proposed Ids Security Policy Rule

PUT

Update Proposed Ids Security Policy Rule

DELETE

Delete Proposed Ids Security Policy Rule

POST

Query Infra Service Categories

GET

Get Infra Segmentation Service Category

GET

List Default Ids Profiles

GET

Get Default Ids Profile

PUT

Update Default Ids Profile