Skip to content

Public VCF

All operations require authentication.

4 operationsv1/vrack/{serviceName}
View as Markdown (opens in a new tab)
Agent setup

List attached Public VCF virtual datacentersProduction

GET
/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter

Path parameters

serviceName
required
string

The internal name of your vrack

Response

200string[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get an attached Public VCF virtual datacenterProduction

GET
/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter/{vmwareCloudDirectorVirtualDataCenter}

Path parameters

serviceName
required
string

The internal name of your vrack

vmwareCloudDirectorVirtualDataCenter
required
string

vmwareCloudDirectorVirtualDataCenter service name

Response

200vmwareCloudDirectorVirtualDataCentersuccessful operation
vmwareCloudDirectorVirtualDataCenter
read-only
string

vmwareCloudDirectorVirtualDataCenter service name

vrack
read-only
string

vrack name

Example uses serviceName = string, vmwareCloudDirectorVirtualDataCenter = string

$ curl https://api.eu.ovhcloud.com/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter/{vmwareCloudDirectorVirtualDataCenter} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "vmwareCloudDirectorVirtualDataCenter": "string", "vrack": "string"}

Attach a Public VCF virtual datacenterProduction

POST
/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter

Attach a Public VCF virtual datacenter. Attaches a Public VCF as-a-Service virtual datacenter to the vRack. Returns the task that performs it.

Path parameters

serviceName
required
string

The internal name of your vrack

Request body (required)

vmwareCloudDirectorVirtualDataCenter
required
string

vmwareCloudDirectorVirtualDataCenter service name

Response

200Tasksuccessful operation
function
read-only
string
—
id
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
orderId
read-only
integer
—
serviceName
read-only
string
—
status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneinittodo
targetDomain
read-only
string
—
todoDate
read-only
stringdate-time
—

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "orderId": 0, "serviceName": "string", "status": "cancelled", "targetDomain": "string", "todoDate": "2024-01-01T12:00:00Z"}

Detach a Public VCF virtual datacenterProduction

DELETE
/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter/{vmwareCloudDirectorVirtualDataCenter}

Detach a Public VCF virtual datacenter. Detaches the Public VCF virtual datacenter from the vRack. Returns the task that performs it.

Path parameters

serviceName
required
string

The internal name of your vrack

vmwareCloudDirectorVirtualDataCenter
required
string

vmwareCloudDirectorVirtualDataCenter service name

Response

200Tasksuccessful operation
function
read-only
string
—
id
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
orderId
read-only
integer
—
serviceName
read-only
string
—
status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneinittodo
targetDomain
read-only
string
—
todoDate
read-only
stringdate-time
—

Example uses serviceName = string, vmwareCloudDirectorVirtualDataCenter = string

$ curl https://api.eu.ovhcloud.com/v1/vrack/{serviceName}/vmwareCloudDirectorVirtualDataCenter/{vmwareCloudDirectorVirtualDataCenter} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "orderId": 0, "serviceName": "string", "status": "cancelled", "targetDomain": "string", "todoDate": "2024-01-01T12:00:00Z"}