API specification

Overview

The OpenAPI  specification below describes the plugin foundation release. It combines the Control Plane 3.1.0, Data Plane 4.0.0, and IAM 2.5.0 APIs from their released sources. See the changelog for the compatible set. Older installations do not support every operation or field shown here.

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