Notice: Release Notes for previous releases are archived yearly:
API documentation is available with the product. To access all Swagger documents from a single landing page, go to:
https://www.mgmt.cloud.vmware.com/automation-ui/api-docs/ for vRealize Automation Cloud.
https://<appliance.domain.com>/automation-ui/api-docs for vRealize Automation 8.x, where appliance.domain.com is your vRealize Automation appliance.
Before using the API, consider the latest API updates and changes for this release, and note any changes to the API services that you use. If you have not locked your API using the apiVersion variable before, you might encounter a change in an API response. Any API updates and changes are provided in the What's New section for each release.
For unlocked APIs, the default behavior varies depending upon the API.
For Cloud Assembly IaaS APIs, all requests which are executed without the apiVersion parameter will be redirected to the first version which is 2019-01-15. This redirect will allow every user who did not previously specify the apiVersion parameter to transition smoothly to the latest version without experiencing breaking changes.
NOTE: For the Cloud Assembly IaaS APIs, the latest version is apiVersion=2021-07-15. If left unlocked, IaaS API requests will be redirected to the first version which is 2019-01-15. The first version is deprecated and will be supported for 24 months. To ensure a smooth transition to the new version, lock your IaaS API requests with the apiVersion parameter assigned to 2021-07-15.
For other APIs, your API requests will default to the latest version. If you select one of the earlier version dates listed for the Swagger spec, the API behavior will reflect APIs that were in effect as of that date and any date until the next most recent version date. APIs are not versioned for every vRealize Automation release and not all APIs support the apiVersion parameter.
For more information about using the apiVersion parameter, see the Programming Guides listed in vRealize Automation APIs and CLI.