VMware Aria Automation Assembler IaaS API

VMware Aria Automation Assembler IaaS API

IAAS API is a RESTful service, which allows users to execute provisioning related UI actions via an API.

This page describes the RESTful APIs for IAAS API. The APIs facilitate CRUD operations on the various resources and entities used throughout VMware Aria Automation Assembler(Cloud Accounts, Cloud zones, Computes, Mappings, etc.) and allows operations on them (creating a cloud account, patching a machine, creating image progile, etc.).

The APIs that list collections of resources also support OData like implementation. Below query params can be used across different IAAS API endpoints

Example:

  1. $orderby - returns a result with the rows being sorted by the values of provided attribute. /iaas/api/cloud-accounts?$orderby=name%20desc

  2. $top - number of records you want to get. /iaas/api/cloud-accounts?$top=20

  3. $skip - number of records you want to skip. /iaas/api/cloud-accounts?$skip=10

  4. $select - select a subset of properties to include in the response. /iaas/api/machines?$select=name

  5. $filter - filter the results by a specified predicate expression. Operators: eq, ne, and, or.
    /iaas/api/cloud-accounts?$filter=name%20eq%20'ABC*' - name starts with 'ABC'
    /iaas/api/cloud-accounts?$filter=name%20eq%20'*ABC*' - name contains 'ABC'
    /iaas/api/cloud-accounts?$filter=name%20eq%20'*ABC' - name ends with 'ABC'
    /iaas/api/cloud-accounts?$filter=name%20ne%20'example-cloud-account'%20or%20customProperties.isExternal%20eq%20'false'\

    /iaas/api/projects and /iaas/api/deployments support different format for partial match:
    /iaas/api/projects?$filter=startswith(name, 'ABC') - name starts with 'ABC'
    /iaas/api/projects?$filter=substringof('ABC', name - name contains 'ABC'
    /iaas/api/projects?$filter=endswith(name, 'ABC') - name ends with 'ABC'\

  6. $count - flag which when specified, regardless of the assigned value, shows the total number of records. If the collection has a filter it shows the number of records matching the filter.
    /iaas/api/cloud-accounts?$count=true

  7. page, size - page used in conjunction with size helps in pagination of resources. /iaas/api/storage-profiles/{id}/storage-profile-associations?page=0&size=10