GEgetorchestra
Environments

Get an environment

Changed on

Fetch a single environment by its ID, including its variable values.

get/environments/{environment_id}

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/environments/{environment_id}
  • 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

Path parameters

environment_idstring uuid4 required

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
valuesobject required
createdAtstring required
updatedAtstring required

Changes

  • e45165e7e223Revision changes
    • breaking

      response property values/additionalProperties/value list-of-types was widened by adding types array and object to media type application/json of response 200

    • warning

      added the new dict enum value to the // response property for the response status

    • warning

      added the new list enum value to the // response property for the response status

    • 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