The API on Cloud Avenue
Overview
Two types of API are available :
- The vCloud Director API
- The Cloud Avenue API
All these APIs are exposed on the internet and on the BVPN.
Access to the API
The use of an “organization administrator” account is required to access the APIs. This account can be:
- local (created by the tenant’s administrator)
- federated (created by a contract referent from the Cloud Customer Space) and using the SSO.
Online documentations
The API usable on Cloud Avenue are listed below:
| Composant | Link to the online documentation |
|---|---|
| API Cloud Director & NSX | https://github.com/ccouzens/vcloud-rest-openapi https://vdc-download.vmware.com/vmwb-repository/dcr-public/772aa4c5-7e61-4d80-8432-b8e0d821c969/2747ec83-6aef-4560-b1d1-55ed9adc4e73/vcd-openapi-docs.html |
| API DraaS for VCDA | https://developer.vmware.com/apis/1173/vmware-cloud-director-availability#/ |
| API Kubernetes for CSE | https://developer.vmware.com/apis/vmware-cloud-director/latest/cloudapi/1.0.0/tkgClusters/post/ |
| API Cloud Avenue for customers | Follow this page link API Cloud Avenue |
| API vROPS Tenant | https://github.com/bakingclouds/vRealize-Operations-Tenant-App/blob/main/TenantApp%20v8.6_swagger.json |
| API Backup API for NSS | https://backup3.flexible-computing-advanced.orange-business.com/NetBackupSelfServiceNetBackupPanels/Swagger/ |
| API vCenter for vCoD (if dedicated WLD) | https://support.citrix.com/article/CTX214389 |
| API UseItCloud v1.0 | https://195.25.22.52/api/v1.0/docs/ |
Recommended tools
Postman
This application allows building and executing HTTP requests, and more!
Donwload here: https://www.postman.com/downloads/
Ansible
It is the benchmark for automation software based on API calls.
Documentation and download here: https://github.com/vmware/ansible-module-vcloud-director/blob/master/docs/index.md
Terraform
Terraform is widely used by “infra as code” oriented developers. Terraform works with “providers“, which are translators for interfacing standard Terraform commands to local APIs.
We have developed a specific provider for Cloud Avenue, which provides many additional features (backup, S3 storage, etc.).
The online documentation of our Terraform provider is here: https://registry.terraform.io/providers/orange-cloudavenue/cloudavenue/latest/docs
VCD CLI
See the practical sheet on APIs