Update Segmentation Settings

Update the global settings for segmentation-related operations.

Updates the group delimiter and group prefix. Both settings apply to any operation that creates groups, including segmentation planning and infrastructure monitoring. The updated settings are returned in the response.

Notes

These are global settings; updating them affects all subsequent group-creating operations across all sessions.
Existing published groups are not renamed when settings change - only new publications use the updated values.
Returns 200 on success.

Request

URI

PUT

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

COPY

Request Body

SegmentationSettings of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineSegmentationSettings1

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

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

200

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": 1782343276186,
    "_revision": 2,
    "id": "global_segmentation_settings",
    "display_name": "Global Segmentation Settings",
    "site_ids": [],
    "group_delimiter": ".",
    "group_prefix": "Group",
    "rule_prefix": "Rule",
    "policy_prefix": "Policy",
    "auto_sync_private_ip_range_groups": true
}

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.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/ssp/segmentation/settings

On This Page

Description

Request

Request Body

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