List Segmentation Objects

List Segmentation Objects
Get a list of segmentation objects with pagination and filtering supported

Returns a paginated, filterable list of segmentation objects across all types (applications, environments, tiers, infrastructure asset groups, and regions/zones).

Notes:

  • All request filters are optional and can be combined.
  • segmentation_type restricts results to one or more object types.
  • parent_id finds child objects (e.g., tiers of an application); child_id finds parent objects (e.g., the application containing a tier).
  • application_type, application_workload_type, and flow_prioritization_enabled apply only when segmentation_type includes APPLICATION.
  • realization_group_filter requires site_id plus either policy_path or realization_id.
  • Use GET /inventory/segmentation/segmentation-objects/{segmentation-object-id} to retrieve full details for a specific object.
Request
URI
POST
https://{api_host}/ssp/inventory/segmentation/segmentation-objects
COPY
Request Body

Filter criteria for listing segmentation objects.

ListSegmentationObjectRequestParameters of type(s) application/json
Required  
This request body class requires all of the following: ListRequestParameters , InlineListSegmentationObjectRequestParameters1 
{
    "segmentation_type": [
        "APPLICATION"
    ],
    "offset": 0,
    "page_size": 50
}
Authentication
This operation uses the following authentication methods.
Responses
200

The list of segmentation objects was successfully retrieved.

Returns SegmentationObjectListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineSegmentationObjectListResult1 
{
    "offset": 0,
    "number_of_results": 50,
    "total_result_count": 2500,
    "total_pages": 50,
    "sort_ascending": false,
    "sort_by": "name",
    "results": [
        {
            "segmentation_type": "APPLICATION",
            "_revision": 3,
            "id": "e6159e7c-a2be-4d7a-862b-73e7e7948d21",
            "display_name": "R1_Z1_env9_app959",
            "site_ids": [],
            "hierarchy": [
                {
                    "scope": "region",
                    "value": "R1",
                    "level": 0
                },
                {
                    "scope": "zone",
                    "value": "Z1",
                    "level": 1
                },
                {
                    "scope": "environment",
                    "value": "env9",
                    "level": 2
                },
                {
                    "scope": "application",
                    "value": "app959",
                    "level": 3
                }
            ],
            "realization_groups": [
                {
                    "display_name": "R1_Z1_env9_app959",
                    "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
                    "realization_id": "b147e808-2574-4ee5-8296-0f9cd24a393f",
                    "status": "SUCCESS",
                    "policy_path": "/infra/domains/default/groups/221a1314-ec1c-375a-ba89-c02ed890cbe0",
                    "tags": [
                        {
                            "scope": "region",
                            "tag": "R1"
                        },
                        {
                            "scope": "zone",
                            "tag": "Z1"
                        },
                        {
                            "scope": "environment",
                            "tag": "env9"
                        },
                        {
                            "scope": "application",
                            "tag": "app959"
                        }
                    ]
                }
            ],
            "status": "SUCCESS",
            "application_alerts": [
                "APPLICATION_NO_APP_CATEGORY_SECTION"
            ],
            "application_type": "CRITICAL",
            "application_workload_type": "EPHEMERAL",
            "flow_prioritization_enabled": false,
            "num_tiers": 1,
            "num_out_of_sync_tiers": 0,
            "num_timed_out_tiers": 0
        },
        {
            "segmentation_type": "APPLICATION",
            "_revision": 2,
            "id": "2285b96b-d2c0-4f69-88aa-88b1e680b759",
            "display_name": "R1_Z1_env9_app909",
            "site_ids": [],
            "hierarchy": [
                {
                    "scope": "region",
                    "value": "R1",
                    "level": 0
                },
                {
                    "scope": "zone",
                    "value": "Z1",
                    "level": 1
                },
                {
                    "scope": "environment",
                    "value": "env9",
                    "level": 2
                },
                {
                    "scope": "application",
                    "value": "app909",
                    "level": 3
                }
            ],
            "realization_groups": [
                {
                    "display_name": "R1_Z1_env9_app909",
                    "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
                    "realization_id": "948b83a7-ce00-42df-8886-57a62289d936",
                    "status": "SUCCESS",
                    "policy_path": "/infra/domains/default/groups/b811e64f-5880-354d-8e2a-666bd209a9e4",
                    "tags": [
                        {
                            "scope": "region",
                            "tag": "R1"
                        },
                        {
                            "scope": "zone",
                            "tag": "Z1"
                        },
                        {
                            "scope": "environment",
                            "tag": "env9"
                        },
                        {
                            "scope": "application",
                            "tag": "app909"
                        }
                    ]
                }
            ],
            "status": "SUCCESS",
            "application_alerts": [
                "APPLICATION_NO_APP_CATEGORY_SECTION"
            ],
            "application_type": "CRITICAL",
            "application_workload_type": "EPHEMERAL",
            "flow_prioritization_enabled": true,
            "num_tiers": 1,
            "num_out_of_sync_tiers": 0,
            "num_timed_out_tiers": 0
        }
    ],
    "inventory_alerts": [
        "ENVIRONMENTS_SOFT_COUNT_LIMIT_EXCEEDED"
    ]
}

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}/ssp/inventory/segmentation/segmentation-objects
On This Page
Asset Collection Operations
POST
List Segmentation Objects
GET
Get Segmentation Object
PUT
Update Segmentation Object