VCF Automation includes an API documentation, which was created with the Swagger tool set.
To access all API specifications from a single landing page add the following path after your FQDN:
/automation/api-docs/#/introduction VCF Automation 9.*
/automation-ui/api-docs/ Aria Automation 8.*
|
Direct Links of Swagger API Documentation
Here a list of direct links to the different services of VCF Automation 9.*:
Orchestrator /vco/api/docs/swagger-ui/index.html
Orchestrator Gateway /vro/webjars/swagger-ui/index.html
|
These links were checked with VCF Automation 9.0.0.
Here a list of direct links to the different services of Aria Automation 8.*:
ABX /abx/api/swagger-ui.html
Approvals /approval/api/swagger/swagger-ui.html
Blueprint /blueprint/api/swagger/swagger-ui.html
Catalog /deployment/api/swagger/swagger-ui.html?urls.primaryName=catalog
CMX /cmx/swagger-ui.html
Content Gateway /content/api/swagger/swagger-ui.html
Custom Forms /form-service/doc/swagger-ui.html
Customization /userprofile/swagger-ui.html
Deployment /deployment/api/swagger/swagger-ui.html?urls.primaryName=deployments
Deployment Metric /approval/api/swagger/swagger-ui/index.html#/Metrics%20Aggregation
Identity /identity/doc/webjars/swagger-ui/index.html
IaaS /iaas/api/swagger/ui/
Migration Assistant /migration/api/swagger/swagger-ui/index.html
Onboarding /relocation/api/swagger/ui/index.html
Orchestrator /vco/api/docs/index.html
Orchestrator Gateway /vro/swagger-ui.html
Pipeline /pipeline/api/swagger/swagger-ui.html
Policies /deployment/api/swagger/swagger-ui.html?urls.primaryName=policies
Projects /project/api/swagger/swagger-ui.html
|
These links were checked with Aria Automation 8.12 and 8.16.