GEgetorchestra
Environments

List environments

Changed on

List the environments for the workspace the credential resolves to. Returns environment metadata only — fetch a single environment by ID to retrieve its variable values.

get/environments

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/environments
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:read

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Response

Successful Response

accountIdstring uuid4 required
environmentIdstring uuid4 required
namestring required
defaultEnvboolean required
allowedBranchesstring[]
allowUnpublishedPipelinesboolean

Changes

  • e45165e7e223Revision changes
    • info

      the endpoint scheme security BearerAuthReadOnly was removed from the API

    • info

      added the new optional header request parameter X-Orchestra-Account-Id

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status