vRealize Orchestrator Server API Operations Index
All available vRealize Orchestrator Server API Operations
Actions Service
DELETE
Delete Action
Delete an action
DELETE
Delete Permission Rule
Deletes a single permission rule with a given id
DELETE
Delete Permissions For Object
Deletes all permissions for an action with a given id
POST
Execute Action By Id
Runs an action with given id
POST
Execute Action By Name
Runs an action with given category and name
GET
Export Action
Export an action with given id
GET
Get Action
Retrieves the definition of an action by categoryName and actionName
GET
Get Permission Rule
Retrieves details for a specific permission rule
GET
Get Permissions For Object
Retrieves action permissions
POST
Import Action
Import an action in the given category
POST
Insert Permissions For Object
Sets permissions for an action with given id
GET
List All Actions
Retrieves a list of all actions
PUT
Update Permission Rule
Updates principal or access rights for a single permission rule with a given id
Authorization Groups Service
PUT
Add Reference To Group
Creates an Orchestrator's authorization group
POST
Create Authorization Group
Creates an Orchestrator's authorization group
DELETE
Delete Authorization Group
Delete an Orchestrator's authorization group
GET
Get Authorization Group
Get an Orchestrator's authorization group
Catalog Service
GET
Download Icon For Module
Download icon for module
GET
Download Icon For Type
Download icon for type
GET
Fetch Plugin Metadata
Fetch plugin metadata
GET
Find By Id
Find by id
GET
Find By Relation
Find by relation
GET
Find Root Element
Find root element
GET
Find Simple List Query
List objects for specific type
GET
List Namespaces
List namespaces
GET
List Object Tags
List object tags
POST
Tag Object
Attach tag to entity
DELETE
Untag Object
Remove tag from entity
Category Service
POST
Add Child Category
Add child category
POST
Add Root Category
Add root category
DELETE
Delete Category
Delete category
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Deletes all permissions
GET
Get Category
Get category
GET
Get Permission Rule
Get permission rule
GET
Get Permissions For Object
Get category permissions
POST
Insert Permissions For Object
Insert permissions
GET
List Categories
Get all categories
PUT
Update Permission Rule
Update permission rule
Configuration Service
DELETE
Delete Configuration
Delete configuration
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Delete configuration permissions
GET
Export Configuration
Export configuration
GET
Get Permission Rule
Get permission rule
GET
Get Permissions For Object
Get configuration permissions
POST
Import Configuration
Import configuration
POST
Insert Permissions For Object
Insert configuration permissions
GET
List All Configurations
List all configurations
PUT
Update Configuration
Update ? configuration
PUT
Update Permission Rule
Update permission rule
Content Service
DELETE
Delete Action
Delete action
DELETE
Delete Package
Delete package
DELETE
Delete Workflow
Delete workflow
GET
Export Action
Export action
GET
Export Package
Export package
GET
Export Workflow
Export workflow
POST
Import Action
Import action
POST
Import Package
Import package
POST
Import Workflow
Import workflow
GET
List Actions
List actions
GET
List All Packages
List all packages
GET
List Content Types
List content types
GET
List Workflows
List workflows
Custom Event Service
POST
Send Custom Event
Send custom event.
Debugger Service
POST
Change Slot Entry
Set multiple workflow breakpoints
POST
Eval Script
Evaluate script
GET
Get Debugger Enabled
Get global debugger state
GET
Get Script Slot Entries
Current variables
GET
Get Workflow Breakpoints
Get workflow breakpoints
GET
Get Workflow Debug Location
Get workflow debugger location
GET
Get Workflow Debugger Enabled
Get debug mode for a specific execution
DELETE
Remove All Workflow Breakpoints
Remove all breakpoints for a workflow
POST
Resume Workflow
Resume
POST
Set Debugger Enabled
Set the global debugger state
POST
Set Workflow Breakpoint
Set workflow breakpoint
POST
Set Workflow Breakpoints
Set multiple workflow breakpoints
POST
Step Into Workflow
StepInto
POST
Step Over Workflow
StepOver
POST
Step Return Workflow
StepReturn
Deprecated
PUT
Disable Plugin
Enable/disable plugin
GET
Export Plugin
Export plugin
POST
Import Plugin
Import plugin
POST
Install Plugin Dynamically
Install plugin dynamically
GET
List All Plugins
List all plugins
Inventory Service
GET
Browse Inventory Path
Browse inventory path
Orchestrator Server Instance Service
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Delete all permissions for the Orchestrator server
GET
Enumerate Services
Enumerate services
GET
Get Authentication
Get authentication
GET
Get Groups
Get groups
GET
Get Permission Rule
Get permission rule
GET
Get Permissions For Object
Get Orchestrator server permissions
POST
Insert Permissions For Object
Insert permissions for Orchestrator server
PUT
Update Permission Rule
Update permission rule
Packages Service
POST
Add Action To Package
Add action to package
POST
Add Actions To Package
Add actions to package
POST
Add Configuration Element Category To Package
Add configuration category to package
POST
Add Configuration Element To Package
Add configuration element to package
POST
Add Recource Category To Package
Add recource category to package
POST
Add Recource Element To Package
Add recource element to package
POST
Add Workflow Category To Package
Add workflow category to package
POST
Add Workflow To Package
Add workflow to package
PUT
Create Package
Create new package
DELETE
Delete Action Element
Delete action element
DELETE
Delete Configuration Element
Delete configuration element
DELETE
Delete Package
Delete package
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Deletes all permissions
DELETE
Delete Resource Element
Delete resource element
DELETE
Delete Workflow Element
Delete workflow element
POST
Get Import Package Details
Analyses uploaded package file and returns details about package elements and certificate
GET
Get Permission Rule
Get permission rule
GET
Get Permissions For Object
Get package permissions
POST
Import Package
Import package
POST
Import Package Extended
Import package based on a import specification
POST
Insert Permissions For Object
Set permissions for package
GET
List All Packages
List all packages
GET
Package Details
Package details
POST
Rebuild Package
Rebuild package
PATCH
Update Package
Update package
PUT
Update Permission Rule
Update permission rule
Policy Service
POST
Create Policy
Create policy
POST
Create Policy Template
Create policy template
DELETE
Delete Policy
Delete policy
DELETE
Delete Policy Template
Delete policy template
GET
Get All Policies
Get all policies
GET
Get All Policy Templates
Get all policy templates
GET
Get Policies For State
Get all policies in state
GET
Get Policy
Get policy
GET
Get Policy Logs
Get policy logs
GET
Get Policy State
Get policy state
GET
Get Policy Template
Get policy template
PUT
Update Policy Template
Update policy template
Resource Service
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Delete permissions
DELETE
Delete Resource
Delete resource
GET
Export Resource
Export resource
GET
Get Permission Rule
Get permission rule
GET
Get Permissions For Object
Get permissions
POST
Import Resource
Import resource
POST
Insert Permissions For Object
Insert permissions
GET
List Allresources
List all resources
PUT
Update Permission Rule
Update permission rule
POST
Update Resource
Update resource content
Server Configuration Service
GET
Get Category Details
Get scripting API for actions grouped by categories
GET
Get O1 1n Types
Get supported types
GET
Get Plugin Api
Get scripting API for a plugin
GET
Get Scripting Api
Get scripting API
GET
Get Server Configuration
Get server configuration
GET
Get Settings
Get subset of the server configuration settings
POST
Import Server Configuration
Import server configuration
Service Descriptor Service
GET
About Info
Get about info
GET
Docs
Redirect docs to docs/index.html
GET
Enumerate Services
Enumerate services
GET
Get Xml Schema
Get REST XSD schema file
GET
Get Xml Schema
Get REST XSD schema file
GET
Health Status
Get health status
GET
Status
Get vRA registration state
GET
Supported Api Versions
List supported API versions
Tagging Service
GET
Get Tags By Tag Name And Owner
Get tags by tag name and owner
GET
List All Tags
List global and self tags
GET
List Tag Owners
List tag owners
GET
List Tags By Owner
List tags by owner
DELETE
Untag Objects By Tag Name And Owner
Untag object
Task Service
POST
Create Task
Create task
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Delete task permissions
DELETE
Delete Task
Delete task
GET
Get Executions
Get task executions
GET
Get Permission Rule
Get permission rule
GET
Get Permissions For Object
Get task permissions
GET
Get Task
Get task
GET
Get Tasks
Get tasks
POST
Insert Permissions For Object
Set task permissions
PUT
Update Permission Rule
Update permission rule
POST
Update Task
Update task
User Interaction Service
GET
Get All User Interactions
Get all user interactions
User Service
GET
User Meta
Get user information
Workflow Presentation Service
GET
All Presentation
Get all presentations
DELETE
Delete Workflow Execution
Delete workflow execution
GET
Get Presentation For
Get presentation
GET
Load Execution
Load Execution
POST
Start Presentation
Start presentation
POST
Update Presentation
Update presentation
PUT
Update Presentation
Update presentation
Workflow Run Service
POST
Answer User Interaction
Answers user interaction
DELETE
Cancel Workflow Execution
Cancel workflow run
DELETE
Delete Workflow Execution
Delete workflow run
GET
Get All Executions For
Get all executions
GET
Get User Interaction
Get user interaction
GET
Get Workflow Execution
Get workflow execution
GET
Get Workflow Execution Logs
Get workflow run logs
GET
Get Workflow Execution State
Get workflow execution state
GET
Get Workflow Execution Statistics
Get workflow execution statistics
GET
Get Workflow Execution Syslogs
Get workflow run system and event logs
POST
Start Workflow Execution
Start workflow execution
Workflow Service
DELETE
Delete Permission Rule
Delete permission rule
DELETE
Delete Permissions For Object
Deletes all permissions
DELETE
Delete Workflow
Delete a workflow
GET
Download Workflow Icon
Access workflow's icon
GET
Download Workflow Schema
Access workflow's schema image
GET
Download Workflow Schema Content
Access workflow's schema
GET
Get All Tasks For Workflow
Retrieves all scheduled tasks for a requested workflow
GET
Get All User Interactions For Workflow
Retrieves all user interactions for a requested workflow
GET
Get All Workflows
Get all workflows
GET
Get Permission Rule
Retrieves permission rule
GET
Get Permissions For Object
Retrieve workflow permissions
GET
Get Workflow
Retrieves the definition of a workflow
POST
Import Workflow
Import/upload a workflow
POST
Insert Permissions For Object
Set workflow permissions
PUT
Update Permission Rule
Updates permission rule
PUT
Validate
Validate workflow content
GET
Validate Existing
Validate existing workflow
Workflow User Interaction Presentation Service
GET
All Interaction Presentations
Get all interaction presentations
DELETE
Delete Workflow Execution
Delete workflow execution
GET
Get Presentation For Interaction
Get presentation for interaction
GET
Load Execution
Load execution
POST
Start Interaction Presentation
Start interaction presentation
POST
Update Presentation
Update presentation
PUT
Update Presentation
Update presentation