Update Proposed Segmentation Object
Updates a proposed segmentation object. This endpoint is primarily used to set the publish_action field to trigger publication or cancel an ongoing publish operation.
Notes
- When publishing a segmentation object, all associated groups will be published.
- Can call
FORCE_PUBLISHwhen the capacity limit for groups will be exceeded - Returns 202 on success
Unique identifier of the segmentation session.
Unique identifier of the proposed segmentation object.
Updated segmentation object
{
"segmentation_object_type": "APPLICATION",
"application_type": "CRITICAL",
"application_workload_type": "REGULAR",
"_revision": 0,
"_create_user": "admin",
"_create_time": 1782337249862,
"_last_modified_user": "admin",
"_last_modified_time": 1782337249862,
"publish_action": "PUBLISH",
"id": "-6286331157426286654",
"display_name": "us-east_az1_test_app1",
"site_ids": [],
"hierarchy_tags": [
{
"scope": "region",
"tag": "us-east"
},
{
"scope": "zone",
"tag": "az1"
},
{
"scope": "environment",
"tag": "test"
},
{
"scope": "application",
"tag": "app-1"
}
],
"proposed_groups": [
{
"_create_user": "admin",
"_create_time": 1782337249862,
"_last_modified_user": "admin",
"_last_modified_time": 1782337249862,
"_revision": 0,
"id": "6742396901173852182",
"display_name": "us-east_az1_test_app-1",
"site_ids": [
"123a456b-123c-456d-89ab-cdef12345678"
],
"group_path": "/infra/domains/default/groups/05b98eff-9d6d-3c2c-b67d-d969974e7346",
"object_count_per_type": [
{
"type": "VIRTUAL_MACHINE",
"count": 9
}
],
"group_action": "CREATE",
"publish_status_info": {
"publish_status": "READY_TO_PUBLISH"
},
"current_effective_vm_count": 0,
"projected_effective_vm_count": 9
}
],
"publish_status": "READY_TO_PUBLISH",
"parent_id": "-5834291957839695920"
}Update accepted and processing asynchronously
{
"id": "-6286331157426286654",
"status_url": "/segmentation/aaaa1111-bbbb-2222-cccc-3333dddd4444/results/proposed-segmentation-objects/-6286331157426286654/status"
}UUID identifier of the response.
The URL to check the status of the operation.
Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unexpected error
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"publish_action":"string"}' https://{api_host}/ssp/segmentation/{session-id}/results/proposed-segmentation-objects/{proposed-segmentation-object-id}