Get Server Groups

Select

SaaS

Customer Managed

Get All Server Groups

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• serverGroupCount int32

  This returns the total number of server groups.

• serverGroups object[]

  name string

  Name of server group.

  id int32

  Id of server group.

  association string

  Possible values: [AUTOMATIC, VM, MANUAL]

  Type of server group association.

  isSyncInProgress boolean

  If true, server group is synchronizing associated servers.

  isCompanySmartClientGroup boolean

  If true, server group is a company smart client group.

  company object

  id int32

  name string

  globalConfigInfo object

  Only applicable on Global CommCells

  id string

  name string

  commcells object[]

  List of Service CommCells where the global configuration is applied

  id int32

  name string

  guid string

  displayName string

  companies object[]

  List of companies where the global configuration is applied

  id int32

  name string

  guid string

  scope string

  The entity level at which the config is applied.

  scopeFilterQuery string

  CommCellEntityCache filter query string used for filtering the scope

  applyOnAllCommCells boolean

  Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  applyOnAllCompanies boolean

  Decides whether the global configuration should be applied to all the companies, including the newly created ones

  isMarkedForDeletion boolean

  Indicates whether global configuration deletion has been started.

  status string

  tags object[]

  Array of all the tags associated with server group

  id int32

  name string

  value string

  commcell object

  name string

  Name of the commcell the entity belongs to.

{
  "serverGroupCount": 0,
  "serverGroups": [
    {
      "name": "string",
      "id": 0,
      "association": "AUTOMATIC",
      "isSyncInProgress": true,
      "isCompanySmartClientGroup": true,
      "company": {
        "id": 0,
        "name": "string"
      },
      "globalConfigInfo": {
        "id": "string",
        "name": "string",
        "commcells": [
          {
            "id": 0,
            "name": "string",
            "guid": "string",
            "displayName": "string"
          }
        ],
        "companies": [
          {
            "id": 0,
            "name": "string",
            "guid": "string"
          }
        ],
        "scope": "string",
        "scopeFilterQuery": "string",
        "applyOnAllCommCells": true,
        "applyOnAllCompanies": true,
        "isMarkedForDeletion": true,
        "status": "string"
      },
      "tags": [
        {
          "id": 0,
          "name": "string",
          "value": "string"
        }
      ],
      "commcell": {
        "name": "string"
      }
    }
  ]
}

Requested Details not found

GET /v4/servergroup    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/ServerGroup' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'