VMware Aria Automation Assembler IaaS API Operations Index
All available VMware Aria Automation Assembler IaaS API Operations
The page contains information about the supported API versions and the latest API version. The version parameter is mandatory for endpoints introduced after version 2019-01-15and optional for the rest though highly recommended.
If you do not specify explicitly an exact version, you will be calling the latest supported General Availability API version.
Here is an example of a call which specifies the exact version you are using: GET /iaas/api/network-profiles?apiVersion=2021-07-15
Note that this version is deprecated: 2019-01-15.
Get certificate info
Enumerate all private images for enabled regions of the specified cloud account
Starts cloud account health check identified by its endpoint state
Get the available regions for specified cloud account
Enumerate all private images for enabled regions of the specified vSphere account
Get the available regions for specified vSphere cloud account
Get all vSphere cloud accounts within the current organization
Create a cloud account in the current organization
Enumerate all private images for enabled regions of the specified VMC account
Get the available regions for specified VMC cloud account
Get all VMC cloud accounts within the current organization
Create a cloud account in the current organization
Enumerate all private images for enabled regions of the specified VCF account
Get the available regions for specified VCF cloud account
Get all VCF cloud accounts within the current organization
Create a cloud account in the current organization
Get all NSX Manager cloud accounts within the current organization
Create a NSX Manager cloud account in the current organization
Enumerate all private images for enabled regions of the specified GCP account
Get the available regions for specified GCP cloud account
Get all GCP cloud accounts within the current organization
Create a cloud account in the current organization
Enumerate all private images for enabled regions of the specified Azure account
Get the available regions for specified Azure cloud account
Get all Azure cloud accounts within the current organization
Create a cloud account in the current organization
Enumerate all private images for enabled regions of the specified AWS account
Get the available regions for specified AWS cloud account
Get all AWS cloud accounts within the current organization
Create a cloud account in the current organization
Get all cloud accounts within the current organization
Create a cloud account in the current organization
Get cloud account with a given id
Delete a cloud account with a given id
Update a single CloudAccount
Get an vSphere cloud account with a given id
Delete a vSphere Cloud Account with a given id
Update vSphere cloud account
Get an VMC cloud account with a given id
Delete an VMC cloud account with a given id
Update VMC cloud account
Get an VCF cloud account with a given id
Delete an VCF cloud account with a given id
Update VCF cloud account
Get an NSX Manager cloud account with a given id
Delete a NSX Manager cloud account with a given id
Update NSX Manager cloud account
Get an GCP cloud account with a given id
Delete an GCP cloud account with a given id
Update GCP cloud account
Get an Azure Cloud Account with a given id
Delete an Azure Cloud Account with a given id
Update Azure cloud account
Get an AWS cloud account with a given id
Delete an AWS cloud account with a given id
Update AWS cloud account
Get region enumeration response for a given id
Unregister a vSphere provisioned machine
Second day suspend operation for machine
Second day create snapshot operation for machine
Second day shut down operation machine
Second day revert snapshot operation for machine
Second day restart operation for machine
Second day resize operation for machine
Second day reset operation for machine
Second day reboot operation for machine
Second day power-on operation for machine
Second day power-off operation for machine
Get all machines
Create machine
Get machine with a given id
Delete Machine with a given id
Update machine. Only description, tag, custom property and bootConfig updates are supported. Please note that all existing tags, assigned to this machine, that are not implicitly added in the Patch body, will be unassigned from this machine!All other properties in the MachineSpecification body are ignored.
Get snapshot with a given id for specific machine
Second day delete snapshot operation for machine
Get machine snapshots information
Get all compute gateways
Create a new compute gateway.
Get compute gateway with a given id
Delete compute gateway with a given id
Day-2 reconfigure operation for nat
Get all Compute Nats
Create a new Compute Nat.
Get Compute Nat with a given id
Delete compute nat with a given id
Get All Custom Names
Update custom name
Create Custom Name
Get Custom Name by Id
Delete custom name with a given id
Get Custom Names For Project Id
Get all Data Collectors.
Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release.
Create a new Data Collector.
Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release.
Get Data Collector with a given id.
Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release.
Delete Data Collector with a given id.
Note: Data collector endpoints are not available in VMware Aria Automation (on-prem) release.
Get all deployments.
Create a new Deployment.
Get a single deployment.
Delete a deployment.
Second day create snapshot operation for Block device
Second day promote operation on disk. Applicable for vSphere Block Devices only
Get a single BlockDevice
Resize operation on block device.
Delete a BlockDevice
A block device cannot be deleted when attached to a machine.
A block device with persistent property set to 'false' is deleted.
A block device with persistent property set to 'true' needs an additional parameter 'purge' to be set to true, for deletion.
Second day revert snapshot operation for Block device
Get all BlockDevices
Following disk custom properties can be passed while creating a block device:
1. dataStore: Defines name of the datastore in which the disk has to be provisioned.
2. storagePolicy: Defines name of the storage policy in which the disk has to be provisioned. If name of the datastore is specified in the custom properties then, datastore takes precedence.
3. provisioningType: Defines the type of provisioning. For eg. thick/thin.
4. resourceGroupName: Defines the Azure resource group name where the disk needs to be provisioned.
Get snapshot with a given id for specific disk
Second day delete snapshot operation for Block device
Get disk snapshots information
Get all fabric AWS volume types.
Get all Azure disk encryption sets
Get fabric Azure storage account with a given id
Get all fabric Azure storage accounts.
Get fabric compute with a given id
Update fabric compute. Only tag updates are supported.
Get all fabric computes.
Get all fabric flavors
Get enumerated fabric image with a given id. Fabric images are enumerated images from a specific region, which could be used in image mappings.
Get all enumerated fabric images
Get fabric network with a given id
Update fabric network. Only tag updates are supported.
Get vSphere fabric network with a given id
Update vSphere fabric network.
Get associated fabric network IP ranges for a fabric network with a given id
Get associated fabric network IP ranges for a fabric vSphere network with a given id
Get all vSphere fabric networks.
Get all fabric networks.
Get fabric vSphere datastore with a given id
Update Fabric vSphere Datastore. Only tag updates are supported.
Get all fabric vSphere datastores.
Get fabric vSphere storage policy with a given id
Get all fabric vSphere storage polices.
Get all flavor profile
Create flavor profile
Get flavor profile with a given id
Delete flavor profile with a given id
Update flavor profile
Get all flavors defined in FlavorProfile
Get all folders within the current organization
Get all image profiles
Create image profile. This image profile is created for the specific region. Image mapping definitions are created together with the profile. All existing image mapping definitions for the specified region will be replaced with the payload provided and if you want to keep the existing definitions, they should be added to the payload.
Get image profile with a given id
Delete image profile with a given id
Update image profile. All existing image mapping definitions for the specified region will be replaced with the payload provided and if you want to keep the existing definitions, they should be added to the payload.
Get all images defined in ImageProfile. To get all enumerated images use Fabric Image endpoint.
Get all integrations within the current organization
Create an integration in the current organization asynchronously
Get an integration with a given id
Delete an integration with a given id asynchronously
Update a single integration asynchronously
Second day scale operation for load balancer
Second day delete operation for load balancer
Get all load balancers
Create load balancer
Get network interface with a given id for specific load balancer
Get load balancer with a given id
Delete load balancer with a given id
Get all zones
Create zone
Get zone with given id
Delete a zone
Update zone
Get zone's computes by given zone ID
Get Region with a given id
Get all regions
Retrieve AuthToken for local csp users.
When accessing other endpoints the Bearer authentication scheme and the received token must be provided in the Authorization request header field as follows:
Authorization: Bearer {token}
Get all Event logs
Get all networks
Provision a new network based on the passed in constraints. The network should be destroyed after the machine is destroyed to free up resources.
Get associated network IP ranges for a network with a given id
Get network with a given id
Delete a network with a given id
Get network domain with a given id
Get all network domains.
release unregistered network IPs
release network IPs by user
allocate network IPs by user
Get all internal IPAM network IP ranges
Creates an internal network IP range.
Get internal IPAM network IP range with a given id
Delete internal network IP range with a given id
Update internal network IP range.
Get external IPAM network IP range with a given id
Assign the external IPAM network IP range to a different network and/or change the tags of the external IPAM network IP range.
Get an allocated or released address of an IPAM network IP range
Get all allocated and released addresses of an IPAM network IP range
Get all external IPAM network IP ranges
An external IP block is network coming from external IPAM provider that can be used to create subnetworks inside it
An external IP block is network coming from external IPAM provider that can be used to create subnetworks inside it
Get all network profiles
Create network profile
Get network profile with a given id
Delete network profile with a given id
Update network profile
This operation has two purposes:
- Make initial request for importing package. Location of the new package is returned as a response header if body is not provided.
- Finalize the import when all batches are sent to the server if bundleIdis provided or make the complete import if compressedBundle is provided
This API implements the TUS RFC: https://github.com/tus/tus-resumable-upload-protocol/blob/main/protocol.md
Get all zones assigned to a project by pages
Update all zone assignments to a project asynchronously
Get all projects
Create project
Get project resource metadata by a given project id
Update project resource metadata by a given project id
Get project with a given id
Delete project with a given id
Update project
Get all configuration properties
Update or create configuration property.
Get single configuration property
Delete a configuration property
Get request tracker with a given id
Delete a single Request
Get all request trackers
Get Request Graph For Provisioning Request
Day-2 reconfigure operation for new security groups provisioned by VMware Aria Automation. This is not supported for 'existing' security groups
Get all security groups
Provision a new on-demand security group
Get security group with a given id
Delete an on-demand security group with a given id
Update security group. Only tag updates are supported.
Get storage profile with a given id
Replace storage profile with a given id
Delete storage profile with a given id
Get all vSphere storage profiles
Create vSphere storage profile
Get all GCP storage profiles
Create GCP storage profile
Get all Azure storage profiles
Create Azure storage profile
Get all AWS storage profiles
Create AWS storage profile
Get all storage profiles
Create storage profile
Get all storage profile Associations with a given storage profile id
Update storage profile associations
Get vSphere storage profile with a given id
Delete vSphere storage profile with a given id
Update vSphere storage profile
Get GCP storage profile with a given id
Delete GCP storage profile with a given id
Update GCP storage profile
Get Azure storage profile with a given id
Delete Azure storage profile with a given id
Update Azure storage profile
Get AWS storage profile with a given id
Delete AWS storage profile with a given id
Update AWS storage profile
Get documents of all resources that are assigned with the provided tags
Get all tags
Create a new tag
Delete a tag by ID