Overview of the vRealize Automation REST API

<

|

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.

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.

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.

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.

The advanced designer service selection on the Référence de l'API de vRealize Automation landing page selects the documentation for the XaaS service.

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:

https://$host/component-registry/api/services

For more information about all the vRealize Automation REST API service calls, see Using the vRealize Automation API Reference and the Référence de l'API de vRealize Automation in your vRealize Automation installation.