vRealize Automation

vRealize Automation Family API Guide

The vRealize Automation REST API provides consumer, administrator, and provider-level access to the service catalog with the same services that support the vRealize Automation console user interface. You can perform vRealize Automation functions programmatically by using REST API service calls.

REST API Services

Service Description
Approval Service Retrieve, create, update, and delete approval policies, policy types, policy instances, and policy requests.
Branding Service Change the background and text colors, company logo, company name, product name, tenant name, and other resources in the console.
Catalog Service Retrieve global and entitled catalog items, and entitlements for a catalog item and its service that the current user can review. A consumer can retrieve, edit, and submit a request form for a catalog item. A provider can retrieve, register, update, and delete catalog items. Provision and manage systems.
Component Registry Service Access and manage all services and serves as the central view for all service lookups.
Composition Service Allows vRealize Automation services to register application components, which the composition service manages so that they can be used in composite blueprints.
Content Management Service Access and manage the content controller and package controller for export and import processes. This includes export and import for blueprints and software.
Endpoint Configuration Service Create, read, update and delete endpoint types, endpoint categories, and endpoints.
Event Broker Service Provide a central location and a consistent way of recording events and querying for events.
Forms Service Used internally by the vRealize Automation system to create, read, update and delete (perform CRUD operations on) request forms for XaaS components.
IaaS Proxy Provider Service Run a proxy service that acts as a bridge between the service catalog and the IaaS provider to call other services, such as the catalog service, composition service, reservation service, and event broker service.
Identity Service Manage tenants, business groups, SSO and custom groups, users, and identity stores.
IP Address Management Service Allocate and deallocate IP addresses from IP address management (IPAM) providers.
Licensing Service Retrieve permissions and post serial keys. Management Service (Reclamation Service) Retrieve work item forms, callbacks, and tasks. Manage endpoint details including tenant, password, user name, and endpoint URL. Retrieve performance metrics. Retrieve and cancel reclamation requests.
Network Service Access and manage application network and security seĴings for creating and configuring NAT and routed networks; creating load balancers; and adding and configuring security groups, security tags and security policies for application components.
Notification Service Configure and send notifications for several types of events such as the successful completion of a catalog request or a required approval.
Orchestration Gateway Service Provides a gateway to VMware Realize Orchestrator (vRO) for services running on vRealize Automation. By using the gateway, consumers of the API can access a vRO instance, and initiate workflows or script actions without having to deal directly with the vRO APIs.
Extensibility (Plug-in) Service Retrieve, create, update, and delete a resource. Retrieve an extension. Retrieve license notifications.
Placement Service Provides vRealize Automation with recommendations for the placement of deployments. With cluster health information from an external service such as vRealize Operations Manager, the service can recommend reservations to use for the provisioning of blueprint components.
Portal Service Retrieve, create, update, and delete a portal resource.
Properties Service Manage custom properties, property groups, and property definitions. Properties specify items that can be added to blueprints to trigger vRealize Orchestrator actions.
Reservation Service Retrieve, create, update, and delete a reservation or reservation policy.
Software Services Triggers the execution life cycle of software components using the software agent, registers software agents, and manages the creation, modification and deletion of software component, software component types, software resource requests, and nodes (machines).
vRA Orchestrator Service Manage vRealize Orchestrator actions, tasks, packages, and workflows. Browse system and plug-in inventories.
Work Item Service Retrieve, create, update, complete, cancel, and delete a work item. Also retrieve form data, metadata, detail forms, and submission forms from service providers.
XaaS Service Manages XaaS elements such as forms, endpoints, XaaS blueprints, tenants, vRealize Orchestrator imports, workflowsǰ and work items. The advanced designer service selection on the vRealize Automation API Reference landing page selects the documentation for the XaaS service.
Filters HIDE
  • Show only current versions
Products CLEAR
  • vRealize Automation
    • 8.0.0
    • 7.6
    • 7.5
    • 7.4
    • 7.3
    • 7.2.0
    • 7.0.0
Language Bindings CLEAR
  • Java
Show per page