Using the vRealize Orchestrator REST API

You can use the vRealize Orchestrator REST API to perform various workflow-related operations.

The vRealize Orchestrator REST API exposes the objects from the inventories of the vRealize Orchestrator server and the installed plug-ins as resources at predefined URLs. You make HTTP calls at these URLs to trigger operations in vRealize Orchestrator. In this way, you can perform various tasks over all vRealize Orchestrator objects in your library, such as workflows, actions, resource elements, and others:

  • Run a workflow, schedule a workflow, retrieve the runs of a workflow, answer to a user interaction, and cancel a workflow run.
  • Retrieve details about a workflow such as its input and output parameters and its input form schema.
  • Retrieve details about a workflow run, such as its state, generated logs, start date, and end date.
  • Browse the inventories of vRealize Orchestrator and the installed plug-ins.
  • Import and export workflows, actions, and packages.
Note: Do not use the vRealize Orchestrator REST API for installing plug-ins.

By using the vRealize Orchestrator REST API you can easily integrate vRealize Orchestrator workflows in custom applications that you can build in any programing language.

The vRealize Orchestrator REST API also provides eTag support as well as a mechanism for caching of response data.