API specification

Overview

The current OpenAPI  specification of the Platform Orchestrator configuration entities is shown below.

Use the API endpoint configured for your installation. The examples use https://api.orchestrator.example.com as a placeholder.

All requests to the API must be authenticated using an API token placed in the Authorization header as shown here using curl:

export PO_API_URL=https://api.orchestrator.example.com

curl ${PO_API_URL}/orgs/{org_id}/projects \
  -H "Authorization: Bearer ${PLATFORM_ORCHESTRATOR_TOKEN}"

An API token can be issued via service user (recommended for all automation use cases) or via a CLI authentication.

API specification

CLI cheat sheet