Summary:
Update or delete a config set, and pause the synchronization of a config set.
URL:
http(s)://{server hostname}/api/cfg/serverGroups/{serverGroupId}
PUT Method detail - update config set
PUT Method detail - pause synchronization of a config set
Methods summary
- PUT Method - update a specified config set.
- PUT Method - pause synchronization for a specified config set
- DELETE Method - delete a specified config set.
PUT Method detail - update config set
Updates a specified config set.
Request:
| Name | Description |
|---|---|
| serverGroupName |
name of the config set. |
|
description |
description of the config set, if any. |
| syncUsers |
if sync of users is enabled in this config set, either 'true' or 'false'. |
| syncUserGroups |
if sync of user groups is enabled in this config set, either 'true' or 'false'. |
| syncViews |
if sync of Views is enabled in this config set, either 'true' or 'false'. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroups/82e7c418-cd48-4fbf-857b-cddb475841a2-X PUT -H "content-type:application/json" -d '
{
"serverGroupName": "First Group 1 changed",
"description" : "My First Group changed",
"syncUsers": true,
"syncUserGroups" : true,
"syncViews" : false
}
OUTPUT
{
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : false,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"serverGroupName" : "First Group 1 changed",
"description" : "My First Group changed",
"creationTimeSec" : 1676997135,
"createdBy" : "admin",
"syncPaused" : false
}
PUT Method detail - pause synchronization of a config set
Pause the synchronization of a specified config set. To trigger synchronization of a config set, please see Config Sets - Sync.
Request:
| Name | Description |
|---|---|
| syncPaused |
if synchronization of the config set is paused, either 'true' or 'false'. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroups/82e7c418-cd48-4fbf-857b-cddb475841a2-X PUT -H "content-type:application/json" -d
{
"syncPaused": true
OUTPUT
{
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : false,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"serverGroupName" : "First Group 1 changed",
"description" : "My First Group changed",
"creationTimeSec" : 1676997135,
"createdBy" : "admin",
"syncPaused" : true
}
DELETE Method detail
Deletes a specified config set.
Request:
'SUCCESS' when successfully deleted.
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroups/6ed9ccd4-e0b8-4ee9-8f5d-c75974678c78?media=json -X DELETE
OUTPUT
{
"errorCode": "SUCCESS",
"errorDetails": null,
"data": { }
}
Comments
0 comments
Please sign in to leave a comment.