List management groups

Returns a list of management groups.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

Responses

200
default

Success

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

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_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.
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.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
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.
_next object
The HATEOAS link to the next page of results.
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.
_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.
current_count int64
The number of items listed on the current page.
limit int64
The maximum number of items displayed per page in the response.
min_count int64
The total count of groups upto 10. Any number of groups beyond 10 will still be returned as 10.
start string
The page token used to get this response.

{
  "_embedded": {
    "items": [
      {
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "update-management-group": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "id": "string",
        "name": "string",
        "type": "string",
        "vcenter_id": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "min_count": 0,
  "start": "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"
    }
  ]
}

List management groups​

List management groups