Summary:
List config sets, and create new config sets.
URL:
http(s)://{server hostname}/api/cfg/serverGroups
Methods summary
- GET Method - lists all config sets.
- POST Method - creates a new config set.
GET Method detail
Lists all config sets that have been created in a multi-server installation.
Response:
| Name | Description |
|---|---|
| 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'. |
| serverGroupId | ID of the config set. |
| serverGroupName | name of the config set. |
| description | description of the config set, if any. |
| creationTimeSec | timestamp of when the config set was created. |
| createdBy | user who created the config set. |
| syncPaused | if synchronization of the config set is paused. |
Example:
INPUT
curl -u admin:admin https://localhost/api/cfg/serverGroups?media=json
OUTPUT
{
"items" : [ {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"serverGroupName" : "Kim1",
"description" : "",
"creationTimeSec" : 1676997135,
"createdBy" : "kim1",
"syncPaused" : false
}, {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "8a938ad6-a2d8-4620-b3fc-ac8482f60731",
"serverGroupName" : "Kim2",
"description" : "",
"creationTimeSec" : 1676998895,
"createdBy" : "kim1",
"syncPaused" : false
}, {
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "19b4d904-33be-4c54-a613-544c6ef691f8",
"serverGroupName" : "Aardvark",
"description" : "",
"creationTimeSec" : 1677152823,
"createdBy" : "kim1",
"syncPaused" : false
}, {
"syncUsers" : false,
"syncUserGroups" : false,
"syncViews" : true,
"serverGroupId" : "112810b8-265d-4c8d-930c-87f264581634",
"serverGroupName" : "Test1",
"description" : "",
"creationTimeSec" : 1677240349,
"createdBy" : "kim1",
"syncPaused" : false
} ],
"count" : 5
}
POST Method detail
Create a new config set.
Response:
| 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?media=json -X POST -H "content-type:application/json" -d \
{
"serverGroupName": "First Group 1",
"description": "Test group",
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true
}'
OUTPUT
{
"syncUsers" : true,
"syncUserGroups" : true,
"syncViews" : true,
"serverGroupId" : "82e7c418-cd48-4fbf-857b-cddb475841a2",
"serverGroupName" : "First Group 1",
"description" : "Test group",
"creationTimeSec" : 1677514241,
"createdBy" : "admin",
"syncPaused" : false
}
Comments
0 comments
Please sign in to leave a comment.