# ******************************************************************************
# * Copyright 2019-2022 VMware, Inc. All rights reserved. VMware Confidential *
# ******************************************************************************
swagger: "2.0"
info:
version: "36.3"
title: Cloud Director Appliance API
# When editing this description, be careful about how it renders in the docs
contact:
name: VMware, Inc.
url: https://code.vmware.com
email: support@vmware.com
license:
name: ''
url: 'https://code.vmware.com/support'
description: |
The Cloud Director Appliance API can be used to get and change the state information of your Cloud Director appliances. The API is only accessible on port 5480.
Note: This API only returns JSON formatted data.
{
"applianceType": "primary",
"storage": {
"nfs": "192.168.100.1:/data/transfer"
},
"appliance": {
"dbPassword": "vcloud",
"ceip": true
},
"sysAdmin": {
"username": "administrator",
"password": "secret-password",
"fullName": "cloud administrator",
"email": "my-email@my-company.com"
},
"installation": {
"name": "vcd5",
"id": 5
}
}
{
"applianceType": "standby",
"storage": {
"nfs": "192.168.100.1:/data/transfer"
}
}
{
"applianceType": "cell",
"storage": {
"nfs": "192.168.100.1:/data/transfer"
}
}
securityDefinitions:
BasicAuth:
type: basic
BearerAuth:
type: basic
description: This is bearer, despite the type field setting. A limitation of OpenApi 2.0.
basePath: /
paths:
/api/1.0.0/systemSetup:
post:
tags:
- systemSetup
summary: Setup appliance nodes.
x-vcloud-added-in: 36.0
security:
- BasicAuth: []
- BearerAuth: []
operationId: performSystemSetup
consumes:
- application/json
parameters:
- in: body
name: appliance
required: true
schema:
$ref: '#/definitions/ApplianceSystemSetup'
produces:
- application/json
responses:
202:
description: |
Response Body is empty.
Response includes Location header with URL to related task-id.
headers:
Location:
type: "string"
description: "Task URL. Example: https://