Sign in
environments

Get an Environment

Show details of a specific environment.

get/environments/{environment}

Path parameters

environmentstring required

The ID of the environment.

Query parameters

track_accessboolean

Track environment access by the user

includestring[]

The comma-separated list of relationship paths.

accountsstring

The comma-separated list of fields to return in response for Account resource.

agent-poolsstring

The comma-separated list of fields to return in response for AgentPool resource.

drift-detection-schedulestring

The comma-separated list of fields to return in response for DriftDetectionSchedule resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

policy-groupsstring

The comma-separated list of fields to return in response for PolicyGroup resource.

provider-configurationsstring

The comma-separated list of fields to return in response for ProviderConfiguration resource.

storage-profilesstring

The comma-separated list of fields to return in response for StorageProfile resource.

tagsstring

The comma-separated list of fields to return in response for Tag resource.

usersstring

The comma-separated list of fields to return in response for User resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.

Changes

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