Environments

Get a specific Static, Parent or Ephemeral Environment by ID

get/{spaceId}/environments/{id}/v2

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/environments/{id}/v2
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdstring required

The ID of the space containing the resource.

idstring required

ID of the Environment to load

Response

The requested Static, Parent or Ephemeral Environment

Descriptionstring

Gets or sets a short description of this environment that can be used to explain the purpose of the environment to other users. This field may contain markdown.

EnvironmentTagsstring[]

List of tags assigned to this environment

Idstring required
Namestring required

Gets or sets the name of this environment. This should be short, preferably 5-20 characters.

Slugstring required
SpaceIdstring required
Typestring

Example response

{
  "Id": "Environments-1",
  "SpaceId": "Spaces-1"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.