Retrieve a management group

Returns a representation of the specified management group. Management groups are used to manage the SQL hosts and cloud connectors deployed in vCenter servers.

Returns a representation of the specified management-groups.

Path Parameters

group_id string required
Performs the operation on the management group with the specified ID.

Responses

200
default

Success

application/api.clumio.management-groups=v1+json

Schema
Example (from schema)

Schema

_etag string
Etag
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
update-management-group object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
backup_across_subgroups boolean
Determines whether backups are allowed to occur across different subgroups or cloud connectors.
id string
The Clumio-assigned ID of the management group.
name string
The name of the management group.
type string
The type of the management group. Possible values include on_prem.
vcenter_id string
The Clumio-assigned ID of the vCenter server associated with the management group. All management groups are associated with a vCenter server.

{
  "_etag": "string",
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "update-management-group": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "backup_across_subgroups": true,
  "id": "string",
  "name": "string",
  "type": "string",
  "vcenter_id": "string"
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /management-groups/:group_id

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

group_id — path required

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/management-groups/:group_id' \
-H 'Accept: application/api.clumio.management-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

Retrieve a management group​

Authorization

Request

Retrieve a management group