Prerequisites for API Use Case ExamplesLast Updated February 5, 2025
Before performing any task using API services, you must review the prerequisites. General prerequisites apply to all services. Prerequisites that are service-specific are common to all endpoints for the service, but may vary depending upon the service role for example, administrator or user.
General prerequisites for all services
Before performing any task for any service, the following prerequisites must be satisfied:
- Verify that you have an active access token. See Getting Your Authentication Token.
- Verify that the URL variable is assigned.
Prerequisites specific to API services
The following table lists prerequisites that are specific to the services with use cases in this guide.
Every service includes an API version variable. If you choose not to assign a value to the
apiVersion
or to assign it to a different value, review the information in API versioning. Product: Service | Service prerequisites | Role-specific prerequisites |
|---|---|---|
Automation Assembler : Blueprint service
To access the Swagger documentation for the Blueprint API, see https://< .your_FQDN >/blueprint/api/swagger/ui/ | Verify that the Blueprint API version variable is assigned as in the following example. | Verify that you are at least an organization member in VMware Aria Automation with aAutomation Assembler administrator service role. |
Automation Service Broker : Catalog service
To access the Swagger documentation for the Catalog API, see https://< .your_FQDN >/deployment/api/swagger/swagger-ui.html?urls.primaryName=catalog | Verify that the Catalog API version variable is assigned as in the following example. | Verify that you are at least an organization member in VMware Aria Automation with aAutomation Service Broker administrator service role. |
Automation Service Broker : Deployment service
To access the Swagger documentation for the Deployment API, see https://< .your_FQDN >/deployment/api/swagger/swagger-ui.html?urls.primaryName=deploymentsFor the Automation Assembler : Deployment service, use the prerequisites for theAutomation Assembler : Infrastructure as a Service (IaaS) service. | Verify that the Deployment API version variable is assigned as in the following example. | Verify that you are at least an organization member in VMware Aria Automation with aAutomation Service Broker administrator service role. |
Automation Assembler : Infrastructure as a Service (IaaS) service
To access the Swagger documentation for the IaaS API, see https://< .your_FQDN >/iaas/api/swagger/ui/ | Verify that the IaaS API version variable is assigned as in the following example. If you do not assign a value to the apiVersion variable or you assign it to a value other than2021-07-15 , the IaaS API behavior will default to value of the previous version or 2019-01-15. |
|
All products: Onboarding service
To access the Swagger documentation for the Onboarding API, see https://< your_FQDN >/relocation/api/swagger/swagger-ui.html | No version variable needed | Verify that you are at least an organization member in VMware Aria Automation with anAutomation Assembler administrator service role. |
Automation Pipelines : Pipelines service
To access the Swagger documentation for the Pipelines API, see https://< .your_FQDN >/pipeline/api/swagger/swagger-ui.html | Verify that the Pipelines API version variable is assigned as in the following example. | Verify that you are at least an organization member in VMware Aria Automation with anAutomation Pipelines administrator service role. |
Automation Service Broker : Policies service
To access the Swagger documentation for the Policies API, see https://< .your_FQDN >/deployment/api/swagger/swagger-ui.html?urls.primaryName=policies | Verify that the Policies API version is assigned as in the following example. | Verify that you are at least an organization member in VMware Aria Automation with aAutomation Service Broker administrator service role. |
All products: Project service
To access the Swagger documentation for the Projects API, see https://< .your_FQDN >/project/api/swagger/swagger-ui.html | Verify that the Projects API version variable is assigned as in the following example. | Verify that you are at least an organization member in VMware Aria Automation with an administrator service role. |