VMware provides two types of vRealize Automation API documentation. Both types of documentation are available from the VMware {code} site and are intended for administrators and programmers who want to configure and manage vRealize Automation programmatically using the REST API.

vRealize Automation API Reference

Lists all REST API service calls. This documentation is available from the APIs section for the vRealize Automation API at VMware{code} or, https://code.vmware.com/apis/vrealize-automation. Select the service API of interest and click the API Reference tab.

If vRealize Automation is installed, this reference is also available in API Explorer or https://$vRA/component-registry/services/docs, where $vRA denotes an instance of vRealize Automation.

Programming Guide

Provides common use cases including sample requests and responses. This documentation is available from the APIs section for the vRealize Automation API at VMware{code} or, https://code.vmware.com/apis/vrealize-automation. Select the service API of interest and click the Documentation tab.