Get All Environments

Description

'Get All Environments' returns a list of all Environments currently configured on the Controller. The returned list of Environments will give access to Name, IDs, UsedBySchedules etc. of the Environments which is needed to call other endpoints in the API. 

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/environments

Optional request parameters

http://{controllerMachine}:{controllerPort}/api/v3/environments?temporary=true
if “temporary=true” parameter is set then environments will get the temporary schedules 

Examples

Curl

curl -X GET --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v3/enviroments'

PowerShell 

$headers = @{}
$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")
Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/environments" -ContentType "application/json" -Headers $headers -Method GET

Response Body

List of Variables

Response Object

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

500 (Internal Server Error)