CIcircleci
Deploy

Get Environment

Allows getting an environment for a given environment ID.

get/deploy/environments/{environment_id}

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/deploy/environments/{environment_id}
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

environment_idstring uuid required

An opaque identifier of an environment.

Response

Environment

created_atstring date-time

The time when the environment was created

descriptionstring

Short description given to the environment

idstring uuid

The environment ID

namestring

The environment name

updated_atstring date-time

The time when the environment was updated

Example response

{
  "description": "some description",
  "id": "123e4127-e89b-12d3-a456-426123417400",
  "labels": [
    {
      "key": "env",
      "value": "prod"
    }
  ],
  "name": "prod-app"
}

Changes

No recorded changes to this operation across all 1 revision of this API.