List vCenter servers

get deprecatedhttps://{region}.api.clumio.com/datasources/vmware/vcenters

Returns a list of vCenter servers.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

limit

int64

Limits the size of the response on each page to the specified number of items.

start

string

Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

embed

string

Embeds the details of an associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link	Description
read-vmware-vcenter-compliance-stats	Embeds the compliance statistics of VMs into each vCenter server of the response. For example, `?embed=read-vmware-vcenter-compliance-stats`

For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

items

array of objects

A collection of requested items.

items

object

_embedded

object

Embedded responses related to the resource.

_links

object

URLs to pages related to the resource.

backup_region

string

The region to which data is backed-up to for the vCenter server. If the vCenter server's back up region is unavailable, this field has a value of unavailable. Refer to the Back up Regions table for a complete list of back up regions.

cloud_connector_download_url

string

The URL at which the Clumio Cloud Connector for this vCenter server can be downloaded.

endpoint

string

The IP address or FQDN of the vCenter server.

string

The Clumio-assigned ID of the vCenter server.

ip_address

string

The IP address or FQDN of the vCenter server. This field has been replaced by the endpoint field and is being retained for backward compatibility reasons.

organizational_unit_id

string

The Clumio-assigned ID of the organizational unit associated with the vCenter.

status

string

The connection status of the Clumio Cloud Connector. Examples include "pending", "connected", "disconnected", "invalid_credentials", "partial", and "unavailable".

type

string

The type of vCenter server. If the vCenter server's type is unavailable, this field has a value of unavailable. Refer to the vCenter Types table for a complete list of vCenter types.

vcenter_token

string

The token given to the Clumio Cloud Connectors to identify the vCenter server.

_links

object

URLs to pages related to the resource.

_first

object

The HATEOAS link to the first page of results.

_last

object

The HATEOAS link to the last page of results.

_next

object

The HATEOAS link to the next page of results.

_prev

object

The HATEOAS link to the previous page of results.

_self

object

The HATEOAS link to this resource.

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.

start

string

The page number used to get this response.
Pages are indexed starting from 1 (i.e., "start": "1").

total_count

int64

The total number of items, summed across all pages.

total_pages_count

int64

The total number of pages of results.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/datasources/vmware/vcenters \
3
     --header 'accept: application/api.clumio.vmware-vcenters=v1+json'


xxxxxxxxxx
62
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_embedded": {},
6
        "_links": {
7
          "_self": {
8
            "href": "string",
9
            "templated": true,
10
            "type": "string"
11
          },
12
          "read-vmware-vcenter-compliance-stats": {
13
            "href": "string",
14
            "templated": true,
15
            "type": "string"
16
          }
17
        },
18
        "backup_region": "string",
19
        "cloud_connector_download_url": "string",
20
        "endpoint": "string",
21
        "id": "string",
22
        "ip_address": "string",
23
        "organizational_unit_id": "string",
24
        "status": "string",
25
        "type": "string",

200200 HTTP success response

defaultError