Get Segmentation Settings

• Asset Onboarding

Get the global settings for segmentation-related operations.

Returns two global settings used by any operation that creates groups: the group delimiter and the group prefix. Both apply across segmentation planning and infrastructure monitoring features.

Notes

• These settings are global and apply to all sessions, not to any individual session.
• Use PUT /segmentation/settings to update them; changes take effect immediately for any subsequent group-creating operation.
• Returns 200 on success.

Request

URI

GET

https://{api_host}/ssp/segmentation/settings

COPY

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

security_op

auditor

Responses

200

Hide Details

OK

Returns SegmentationSettings of type(s) application/json

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

{
    "_create_user": "system",
    "_create_time": 1781899796657,
    "_last_modified_user": "admin",
    "_last_modified_time": 1782343250123,
    "_revision": 1,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "global_segmentation_settings",
    "display_name": "Global Segmentation Settings",
    "description": "string",
    "site_ids": [],
    "group_delimiter": ".",
    "group_prefix": "Group",
    "rule_prefix": "Rule",
    "policy_prefix": "Policy",
    "auto_sync_private_ip_range_groups": true
}

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.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/ssp/segmentation/settings
                

On This Page

Description

Request

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

POST

Query Csv Entries

GET

Export Annotated Csv

POST

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