Vcenter Service (3.1.0)

Download OpenAPI specification:Download

This is the spec that defines the APIs provided by the vcenter service from GoApp

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

VCenter

getVcenter

Get only specified VCenter details. The VCenter can be identified by IP Address/HostName

Authorizations:
query Parameters
host_name
string

IP/Host Name of the Vcenter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

registerVcenter

Register Vcenter with the VCenter service

Authorizations:
Request Body schema: application/json

Register a new VCenter.

host_name
required
string
username
required
string
password
required
string
tenant_name
required
string

Responses

Request samples

Content type
application/json
{
  • "host_name": "string",
  • "username": "string",
  • "password": "string",
  • "tenant_name": "string"
}

Response samples

Content type
application/json
{
  • "host_name": "10.24.39.224",
  • "name": "SRA VCenter Server",
  • "id": 1,
  • "discovery_status": "Discovered",
  • "tenant_name": "vCenter_10.24.85.166_tenant",
  • "version": "Vcenter 6.5",
  • "datacenters": [
    ],
  • "hosts": [
    ],
  • "virtualmachines": [
    ]
}

deleteVcenter

Delete the specified VCenter from the inventory.

Authorizations:
query Parameters
host_name
required
string

IP/Host Name of the Vcenter to be deleted.

cleanup_tenants
boolean

Flag to indicate whether the tenant and EPGs should be deleted on vCenter Deletion

Responses

Response samples

Content type
application/json
{
  • "host_name": "10.24.39.224",
  • "name": "SRA VCenter Server",
  • "id": 1,
  • "discovery_status": "Discovered",
  • "tenant_name": "vCenter_10.24.85.166_tenant",
  • "version": "Vcenter 6.5",
  • "datacenters": [
    ],
  • "hosts": [
    ],
  • "virtualmachines": [
    ]
}

getVcenterDetails

Get only specified VCenter details. The VCenter can be identified by IP Address/HostName

Authorizations:
query Parameters
host_name
string

IP/Host Name of the Vcenter

Responses

Response samples

Content type
application/json
{
  • "host_name": "10.24.39.224",
  • "name": "SRA VCenter Server",
  • "id": 1,
  • "version": "Vcenter 6.5",
  • "datacenters": [
    ]
}

updateVCenter

Update the specified Vcenter details in the inventory.

Authorizations:
path Parameters
host_name
required
string

IP Address/Host Name of the VCenter to be updated.

Request Body schema: application/json

Update vcenter if credentials changes provide new username and password

host_name
required
string
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "host_name": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json