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.
Design and manage anything-as-a-service (XaaS) elements such as forms, endpoints, XaaS blueprints, tenants, vRealize Orchestrator imports, workflows, and work items. Create XaaS Custom Resources, Blueprints, Resource Mappings and Actions.
The Advanced Service Designer capability enables developers to:
The IP address management (IPAM) service provides tenanted IPAM operations (static IP management) through registered IPAM providers. It allows retrieval of available IP address ranges for a single IPAM provider. With the IPAM Service API, you can allocate and deallocate IP addresses from IP address management (IPAM) providers.
Use Approvals to implement approval policies for your service or resource action. This service provides a generic approval mechanism that any provider can use for any artifact, such as a service or a resource action. It also provides a record of the approval process when it completes.
The Approvals capability enables developers...
Create, read, update and delete endpoint types, endpoint categories, and endpoints.
Typical use cases for the endpoint configuration service are:
The event broker REST API provides features for managing subscriptions, event topics, events, and messages. The event broker includes the EventLog service, which provides a centralized location for events and a consistent way of recording events and querying for events in the vRA suite.
The forms service is used internally by the vRealize Automation system to create, read, update and delete (perform CRUD operations on) request forms for XaaS components. A typical use case is creation, update, and deletion of a catalog item request form.
The Identity Service is composed of two components: authentication and authorization. The authentication component manages tenants, business groups (formerly named subtenants), groups (both Single-Sign-On and Custom groups), users and identity stores. The authorization component manages authorization configurations as a set of triples:...
The Notification sService supports configuring and sending notifications for several types of events, such as the successful completion of a catalog request or issuance of a catalog request that requires approval. Configure and send notifications for several types of events such as the successful completion of a catalog request or a required...
The Extensibility service enables you to manage extensions, plugins, and wizard states. Retrieve, create, update, and delete a resource.
You can use the Extensibility REST API to:
The Reservation Management capabilities of vRealize Automation enable developers to retrieve, create, update, and delete a reservation or reservation policy. You can use this generic Reservation Service for any artifact from any provider. For example, a service which follows its own provider-specified behaviors. The Reservation Service is...
Create and manage portal resources in the vRealize Automation dashboard. With the Portal Services API, you can create a portal, retrieve the configuration for a specified portal, update portal configurations, and create a portlet configuration You can also update or delete the configuration for a portlet with a specified universally unique...
Use the Properties Service to manage custom properties, property groups, and property definitions. Properties specify items that can be added to blueprints to trigger vRealize Orchestrator actions. Custom properties provide a mechanism to annotate objects with custom attributes and can be used to invoke custom behavior during...
The Orchestration capabilities of vRealize Automation, powered by the vRealize Orchestrator Server API, enable developers to manage vRealize Orchestrator actions, tasks, packages, and workflows, and to browse system and plug-in inventories. By using the Orchestrator REST API you can easily integrate Orchestrator workflows in custom...
Work Items provide a standard way for services to present work items to users, giving developers a programmatic way to retrieve, create, update, complete, cancel, and delete a work item. Developers can also use this capability to retrieve form data, metadata, detail forms, and submission forms from service providers.
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).
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.
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.
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.
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.
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.
