GET /orchestrator

Returns metadata about the orchestrator API, along with a list of links to application management resources.

Request format

When Forming orchestrator API requests to this endpoint, the request is a basic call, such as:

GET https://orchestrator.example.com:8143/orchestrator

The GET /orchestrator endpoint does not support any parameters; however, as with other orchestrator API endpoints, you must provide authentication.

Response format

The response is a JSON object using these keys:

Key	Definition
info	Contains the API title, description, version compatibility warnings, the current version, and license information.
status	A URI path you can call to check the orchestrator API status. To check the status of orchestrator services, use the Status API. This endpoint is not documented, so this is a guess.
collections	URI paths you can use to call various endpoints, such as the Jobs endpoints and the environments endpoint. The environments endpoint response tells you either which environments are available or whether a named environment exists. This endpoint is not documented, so this is a guess.
commands	URI paths for the Command endpoints.

For example:

{
  "info" : {
    "title" : "Application Management API (EXPERIMENTAL)",
    "description" : "Multi-purpose API for performing application management operations",
    "warning" : "This version of the API is experimental, and might change in backwards-incompatible ways in the future",
    "version" : "0.1",
    "license" : {
      "name" : "Puppet Enterprise License",
      "url" : "https://puppetlabs.com/puppet-enterprise-components-licenses"
    }
  },
  "status" : {
    "name" : "status",
    "id" : "https://orchestrator.example.com:8143/orchestrator/v1/status"
  },
  "collections" : [ {
    "name" : "environments",
    "id" : "https://orchestrator.example.com:8143/orchestrator/v1/environments"
  }, {
    "name" : "jobs",
    "id" : "https://orchestrator.example.com:8143/orchestrator/v1/jobs"
  } ],
  "commands" : [ {
    "name" : "deploy",
    "id" : "https://orchestrator.example.com:8143/orchestrator/v1/command/deploy"
  }, {
    "name" : "stop",
    "id" : "https://orchestrator.example.com:8143/orchestrator/v1/command/stop"
  } ]
}

Error responses

This endpoint's error responses follow the usual format for Orchestrator API error responses. The endpoint returns a 500 response if the orchestrator API can't be reached.