REST API Services
The vRealize Automation REST API offers the following services and functions.
| Service | Description |
|---|---|
| Advanced Designer Service |
The advanced designer service selection on the vRealize Automation API Reference landing page selects the documentation for the XaaS service. Manages XaaS elements such as forms, endpoints, XaaS blueprints, tenants, vRealize Orchestrator imports, workflows, and work items. |
| 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. |
| Container Service | Request provisioning of an application, described through a high-level definition or blueprint. The Provisioning service reduces to a model of resources with code to run, requirements, and relationships. |
| Content 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. |
| Extensibility Service | Manage extensions, plugins, and wizard states. |
| 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. |
| 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. |
| Orchestration (o11n) 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. |
| 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 suggests 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. |
| 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. |
| Reservation Service | Retrieve, create, update, and delete a reservation or reservation policy. |
| Software Service | 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. |
In addition, the vRealize Health Broker is used to execute integration level tests. It runs application health checks and can be queried to provide the status of individual tests so that health issues are identified early.
API References
API services are installed with the product. References are available with the following URLs.
- To access a list of
general services in the
vRealize Automation API Explorer.
https://$vRA/component-registry/services/docs#!/apis
- To access a list of
installation and configuration services as a Swagger document.
https://$vRA:5480/config/
- To access a list of health
broker services as a Swagger document.
https://$vRA:8090/discovery/swagger
$vRA denotes an instance of vRealize Automation.