Delete Segmentation Session

Delete segmentation session

Deletes a segmentation session and all associated resources including analysis results, proposed groups, applications, and configuration data.

Notes

The segmentation session can create child resources like proposed segmentation groups.
In the case that there are child resources force delete must be used so that the delete will cascade to the child resources.
Returns 200 on success
Will also return 200 on an already deleted session

Request

URI

DELETE

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

COPY

Path Parameters

string

session-id

Required

Unique identifier of the segmentation session

Query Parameters

boolean

force

Optional

Constraints: default: false

Flag to indicate force deletion. This will result in a cascade delete of the child resources.

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

200

Session successfully deleted

Operation doesn't return any data structure

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

On This Page

Description

Request

Path Parameters

Query 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