What are the VMware Aria Automation APIs and how do I use
them
VMware Aria Automation
APIs and how do I use
themAs a VMware Aria®Automation™ user or customer, you can perform
VMware Aria Automation Assembler
, VMware Aria Automation Service Broker
, and
VMware Aria Automation Pipelines
functions
programmatically by using REST API service calls. API Services
VMware Aria Automation
includes the
following APIs. API documentation is available with the product. To access all
Swagger specifications from a single landing page, go to
https://<
where your_FQDN
>/automation-ui/api-docsyour_FQDN
is the FQDN of your VMware Aria Automation
appliance.Main Service | Service Name and Description |
---|---|
ABX |
|
Automation Service Broker
|
|
Automation Assembler
|
|
Automation Service Broker
|
|
CMX |
|
Automation Assembler
|
|
Automation Service Broker and Automation Assembler |
|
User Profile |
|
Automation Service Broker
|
|
Automation Service Broker
|
|
Identity |
|
Automation Assembler
|
|
Migration |
|
Relocation |
|
Automation Orchestrator 用戶端
|
|
Automation Orchestrator 用戶端
|
|
Automation Pipelines
|
|
Automation Service Broker
|
|
Project |
|
VMware
provides customers with a 12 month End-of-Life notice for
any breaking changes to public APIs. Any breaking changes are announced in the
release notes included with the VMware Aria Automation
Documentation.API versioning
It is highly recommended but not necessary to use
API versioning. API versioning allows you to lock the API to a value and control
when you upgrade to a new API version. If you do not use API versioning, the default
behavior varies depending upon the API.
- For the IaaS APIs, the latest version is2021-07-15. If you consume the IaaS APIs without versioning or if you assign a value other than2021-07-15, requests use the version 2019-01-15.As a best practice, lock your IaaS API requests with theapiVersionquery parameter assigned to2021-07-15so that you ensure a smooth transition to the latest version before the version 2019-01-15 reaches its end of life. See Using Automation Assembler APIs to Build your Resource Infrastructure.
- For other APIs, you can specify any date you choose for theapiVersionquery parameter. If you leave the value unspecified, requests use the latest API version by default. However backward compatibility is not preserved and if the API changes, you might encounter an unexpected change in the API response.As a best practice, use theapiVersionquery parameter in your API requests and lock your API to the latest version listed in the Swagger specification. Then if a new API version is announced, you control when to opt-in to that version by changing theapiVersionquery parameter to the new version value.
The following example shows how to use
the
apiVersion
query parameter for the catalog API. The catalog
API versions are: 2020-08-25, 2020-01-30, and 2019-01-15. Including the additional
apiVersion
query parameter locks the call to the API version
that was in effect as of January 30, 2020 and through August 24, 2020.
GET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-01-30
When you are ready to opt-in to the features
released with the version dated 2020-08-25, change the value of the
apiVersion
query
parameter.Setting theGET https://appliance.domain.com/catalog/api/sources?apiVersion=2020-08-25
apiVersion
query parameter to the latest version ensures that
you will also get updates to the catalog API that occur after 2020-08-25. However,
no breaking changes will occur until a new version is announced and you will only
experience those changes if you change the value of the
apiVersion
query parameter to a date that is equivalent to
the new version or later.API versions
do not change for every
VMware Aria Automation
release and are not the same for all services. To check
API versions for the services you use, go to
https://<
and click the cards to open the Swagger specifications.FQDN
>/automation-ui/api-docsHow Developers Use the VMware Aria Automation APIs
VMware Aria Automation
APIsTo make API service calls, you use a browser
application or an HTTP client application to send requests and review responses. The
following open-source applications are commonly used:
- cURL. http://curl.haxx.se
- jqparser. https://stedolan.github.io/jq/
- Postman application. https://www.getpostman.com/
To learn how to use the API, you start by getting an authentication token. Then you can
perform steps outlined in the use cases in this guide. The use cases include
curl
commands in request examples. To use the commands,
ensure that the jq
command-line JSON processor is installed with
curl
. The jq
parser ensures that responses
are formatted for optimum readability. For information about jq
installation, see https://stedolan.github.io/jq/.