V Centers APIs

V Centers APIs

APIs for managing vCenters

Table of Contents

Note : The ipAddress field in request payload or response body are deprecated and will be removed. Please use fqdn field instead.

1. Get a vCenter

1.1. Prerequisites API

The following data is required

  • ID of the vCenter

1.2. Steps API

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vcenters/c0703437-6756-470b-9e1c-f9d3bbc9b1c6' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters/c0703437-6756-470b-9e1c-f9d3bbc9b1c6 HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 221

{
  "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
  "fqdn" : "sfo-m01-vc01.rainpole.io",
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  },
  "version" : "7.0.1.00000-16796246",
  "status" : "ACTIVE"
}

1.3. Related APIs API

[_getvcenters] API [_getvcenter] API

2. Get the vCenters

2.1. Prerequisites API

None
Get All vCenters

2.2. Steps API

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vcenters' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 499

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "sfo-m01-vc01.rainpole.io",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    },
    "version" : "7.0.1.00000-16796246",
    "status" : "ACTIVE"
  }, {
    "id" : "c0703437-6846-470b-9e1c-f9d3bbc9b1c9",
    "fqdn" : "sfo-w01-vc01.rainpole.io",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1"
    },
    "version" : "7.0.1.00000-16796246",
    "status" : "ACTIVE"
  } ]
}

2.3. Related APIs API

[_getvcenters] API [_getvcenter] API

3. Get vCenters for a domain

3.1. Prerequisites API

The following data is required

  • ID of the Domain

3.2. Steps API

  • Invoke the API.

cURL Request

$ curl 'https://sfo-vcf01.rainpole.io/v1/vcenters?domainId=c0703437-6746-470b-9e1c-f9d3bbc9b1c5' -i -X GET \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request

GET /v1/vcenters?domainId=c0703437-6746-470b-9e1c-f9d3bbc9b1c5 HTTP/1.1
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 260

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "sfo-m01-vc01.rainpole.io",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    },
    "version" : "7.0.1.00000-16796246",
    "status" : "ACTIVE"
  } ]
}

3.3. Related APIs API

[_getvcenters] API [_getvcenter] API
Last updated 2024-08-27 16:13:54 -0700

Operations
GET
Get Vcenters
Retrieve a list of vCenter Servers
GET
Get Vcenter
Retrieve a vCenter Server by its ID