Available Endpoints in Orchestrator
This page has links to reference information for all API endpoints in Orchestrator.
General
| Endpoint | Description |
|---|---|
| Persist Custom Data in a Database | Submit data to Orchestrator that is persisted in a database table called shared_states. For example, a plugin can send a Web notification upon transcode complete or failure. |
| Get Alerts for a User | Get user alerts based on a particular alert category. You can get user alerts based on a particular alert category, and you can filter for the number of alerts, only. |
Monitors
| Endpoint | Description |
|---|---|
| Activate Monitors | Activate monitors for workflows, work orders, scripts, folders, and nodes. |
| Deactivate Monitors | Dectivatesmonitors for workflows, work orders, scripts, folders, and nodes. |
| List Monitors | Return a list of all monitors of a particular type—workflow, work order, script, folder, or node—that are available in Orchestrator. |
Plugins
| Endpoint | Description |
|---|---|
| Plugin Version | Get the installed version of a single plugin or all plugins. |
| Reload One Plugin or All Plugins | Reload a plugin, which prompts Orchestrator to update the code for that plugin. If you do not specify a plugin in the request, Orchestrator reloads all plugins. |
| Reload Plugin Set | Reload a defined set of plugins, which prompts Orchestrator to update the code for those plugins. |
| Enable One Plugin or All Plugins | If you specify a plugin name in the request, enable the plugin so that it can be used in a workflow. If you do not specify a plugin name, enable all Orchestrator plugins. |
| Import a Plugin | Import a plugin into your Orchestrator instance. |
Portlets
| Endpoint | Description |
|---|---|
| Get the Dashboard | Get the Orchestrator dashboard. |
| Portlet Version | Get the installed version of a single portlet or all portlets. |
Queues
| Endpoint | Description |
|---|---|
| Queue Item | Add an item to a queue. |
| Get Queued Items From a Queue | Get a list of queued items from a queue. |
| Look Up an Item in a Queue | Search for an item in one or more queues. |
| Get All Queues | Get all queues for which the user has permissions. If the user making the request is an administrator, all queues are returned. |
| Reorder a Queued Item | Reorder a queued item. |
| Bulk Reorder a Queued Item | Reorder a list of queued items. |
| Check Current Status of Execution Statistics | Get execution queue statistics. |
| Delete an Element from a Managed Queue | Delete an element from a managed queue. |
Tasks
| Endpoint | Description |
|---|---|
| List User Tasks | List tasks associated with a particular user. |
| Get Task Details | Get the details of a task. |
| Submit a Task | Submit a task. |
| Search Tasks | Search for a specific task. |
Work Orders
| Endpoint | Description |
|---|---|
| Get Work Orders for a Workflow | Get work orders associated with a workflow. |
| Initiate a Work Order | Initiate a new work order for a given workflow. |
| Check the Status of a Specific Work Order | Poll the status of a specific work order, identified by its work order ID. |
| Get the Output of a Work Order | Get the output of a work order, for example, step names and step variable names with the associated variable values. |
| Restart a Work Order | Reset a specific work order, identified by its work order ID. The result includes both the overall status for the work order as well as the individual status of each of its steps. |
| Cancel a Work Order | Reset a specific work order, identified by its work order ID. |
| Get Work Order Statistics | Retrieve statistics about work order performance. |
| Check the Status of a Specific Workflow Step | Poll the status of a specific workflow step in a workflow, identified by its work order ID and step name. |
| Restart One or More Work Orders from a Specific Step | Restart a work order from a specific step, or restart multiple work orders from a specific step in each work order. |
| Cancel a Work Step | Cancel a specific step in the workflow. |
| Get Work Step Statistics | Retrieve statistics about workflow step performance. |
Workflows
| Endpoint | Description |
|---|---|
| Get Available Workflows on the System | Get all workflows in Orchestrator and specifies whether each workflow is in a published state or not. Only a published workflow can be initiated as a work order. |
| Import a Workflow | Import a workflow. You must first export the workflow from the source instance of Orchestrator; see Export a Workflow for more information. |
| Import a Workflow with Constraints | Import a workflow with its constraints—sub-workflows and acton (plugin)
templates. This process involves 2 requests:
|
| Export a Workflow | Export a workflow. When you pair this method with Import a Workflow (for development and production machines), you complete a direct deployment of the workflow from one Orchestrator instance to another. |
| Get all Workflow Steps that Use the Same Plugin | Get all workflow steps—across all workflows—that use the same plugin. |
| Get Inputs Specification for a Workflow | Get the run-time parameters for a workflow, along with a flag indicating whether the parameter is required or optional. |
| Get the Output Specification of a Workflow | Get the output specification of a workflow, for example, step names and step variable names without the variable values. |
| Check the Running Status for all Workflows | Indicate which workflows have work orders that are running and which workflows do not. |
| Check the Running Status for a Specific Workflow | Indicate whether or not a specific workflow has work orders that are currently running. |
| Check the Detailed Running Status for a Specific Workflow | Indicate—for a given workflow—the count of work orders corresponding to each execution status. |
| Run Test Cases for Workflow Steps | Run the test cases for steps in a workflow. |
| Get the Status of Executed Test Cases for Workflow Steps | Get the status of test cases for steps in a workflow. |
| Publish a Workflow | Publish a workflow so it can launch running instances (work orders). |
| Get a List of All Workflows that Use a Specific Workflow as a Subworkflow | Get a list of all workflows that use the specified workflow as a subworkflow. |
Resources
| Endpoint | Description |
|---|---|
| Add a Resource | Add a resource. |
| Edit Resource Capacity | Edit resource capacity. |
| Bring a Resource Online | Bring a resource online. |
| Take a Resource Offline | Take a resource offline. |
| Pool Status | Get the status of a resource pool—a group of resources, such as IP addresses and mongrels—so you can track resource usage data across workflows. |
| Edit Pool Capacity | Edit pool capacity. |