Get Segmentation Session

Get segmentation session

Retrieves details of a specific segmentation session by its unique identifier. Returns session metadata including status, timestamps, and configuration.

Notes

The status.status field reflects the current lifecycle stage (e.g., FILE_VALIDATED, FILE_PARSED, ANALYSIS_SUCCESS). Use GET /{session-id}/status for lightweight polling without the full session payload.
The action field shows the last action that was requested; it does not indicate the current processing state.
Returns 200 on success.

Request

URI

GET

https://{api_host}/ssp/segmentation/{session-id}

COPY

Path Parameters

string

session-id

Required

Unique identifier of the segmentation session

Authentication

This operation uses the following authentication methods.

Responses

200

Successfully retrieved segmentation session

Returns SegmentationSession of type(s) application/json

This response body class contains all of the following: ManagedResource , InlineSegmentationSession1

{
    "action": "NONE",
    "_create_user": "admin",
    "_create_time": 1781138986293,
    "_last_modified_user": "admin",
    "_last_modified_time": 1781138986293,
    "_revision": 0,
    "id": "aaaa1111-bbbb-2222-cccc-3333dddd4444",
    "display_name": "session_aaaa1111-bbbb-2222-cccc-3333dddd4444",
    "site_ids": [],
    "status": {
        "status": "FILE_READY_TO_PARSE",
        "progress_percent": 0,
        "error_messages": [],
        "parsing_error_count": 0
    }
}

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 -H 'Authorization: <value>' https://{api_host}/ssp/segmentation/{session-id}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Asset Onboarding Operations

GET

List Segmentation Sessions

POST

Create Segmentation Session

GET

Get Segmentation Settings

PUT

Update Segmentation Settings

GET

Get Segmentation Session

PUT

Update Segmentation Session

DELETE

Delete Segmentation Session

GET

Get Segmentation Session Status

GET

Get Segmentation Session Settings

PUT

Update Segmentation Session Settings

Query Resolved Objects

POST

Query Analysis Alerts

POST

Query Proposed Segmentation Objects

GET

Get Proposed Segmentation Object

PUT

Update Proposed Segmentation Object

GET

Get Proposed Segmentation Object Status

POST

Query Proposed Segmentation Group Resolved Members

POST

Query Proposed Segmentation Group Ip Addresses