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.

The vRealize Automation REST API offers the following services and functions.

Table 1. vRealize Automation REST API Services



Advanced Designer Service

Manage XaaS elements such as forms, endpoints, XaaS blueprints, tenants, vRealize Orchestrator imports, workflows, and work items through the Advanced Designer Service.

The Advanced Designer Service service relates to XaaS in the vRealize Automation console user interface.

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

Access and manage all services and serves as the central view for all service lookups.

Composition Service

Access and manage blueprints.

Content Management

Access and manage the content controller and package controller for export and import processes. This includes export and import for blueprints and software.

Event Broker Service

Provide a central location and a consistent way of recording events and querying for events.

Fabric Service

Access and manage key pairs and network profiles.

Identity Service

Manage tenants, business groups, SSO and custom groups, users, and identity stores.

Licensing Service

Retrieve permissions and post serial keys.

Management 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 settings 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.

Plug-in Service

Retrieve, create, update, and delete a resource. Retrieve an extension. Retrieve license notifications.

Portal Service

Retrieve, create, update, and delete a portal resource.

Properties Service

Manage custom properties, property groups, and property definitions.

Reservation Service

Retrieve, create, update, and delete a reservation or reservation policy.

Software Services

Manage software component types, software resource requests, and nodes (machines).

vCO Service

Manage vRealize Orchestrator actions, tasks, packages, and workflows. Browse system and plug-in inventories.

WorkItem Service

Retrieve, create, update, complete, cancel, and delete a work item. Also retrieve form data, metadata, detail forms, and submission forms from service providers.

When a service request contains a resource URL, the first part of the URL identifies the service and the last part identifies the resource. For example, the following resource URL identifies the catalog service and the providers resource:


For more information about all the vRealize Automation REST API service calls, see Using the vRealize Automation REST API Reference and the REST API Reference in the vRealize Automation Documentation Center at