Orchestrator API v1 endpoints
Use this API to gather details about the orchestrator jobs you run.
-
Forming orchestrator API requests
Instructions on interacting with this API. -
Command endpoints
Use the/command
endpoint to start and stop orchestrator jobs for tasks and plans. -
Events endpoints
Use the/events
endpoint to learn about events that occurred during an orchestrator job. -
Inventory endpoints
Use the/inventory
endpoint to discover which nodes can be reached by the orchestrator. -
Jobs endpoints
Use the/jobs
endpoint to examine orchestrator jobs and their details. -
Scheduled jobs endpoints
Use the/scheduled_jobs
endpoint to gather information about orchestrator jobs scheduled to run. -
Plans endpoints
Use the/plans
endpoint to see all known plans in your environments. -
Plan jobs endpoints
Use the/plan_jobs
endpoint to view details about plan jobs you have run. -
Tasks endpoints
Use the/tasks
endpoint to view details about the tasks pre-installed by PE and those you've installed. -
Root endpoints
Use the/orchestrator
endpoint to return metadata about the orchestrator API. -
Usage endpoints
Use the/usage
endpoint to view details about the active nodes in your deployment. -
Scopes endpoints
Use thescopes
endpoint to retrieve resources for task constraints. -
Orchestrator API error responses
From time to time, you might encounter an error using the orchestrator API. In such cases, you receive an error response.
Related information