Environments

List all Environments

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Responses

200

OK

application/json

get

/api/v1/environments

HTTPcURLJavaScriptPython

GET /api/v1/environments HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "id": 1,
      "displayName": "text",
      "agentGroups": [
        {
          "id": 1,
          "displayName": "text",
          "internalName": "text",
          "isCrossPlatform": true,
          "agents": [
            "text"
          ],
          "environment": {
            "id": 1,
            "displayName": "text"
          },
          "agentDetails": [
            {
              "url": "text",
              "httpPorts": [
                "text"
              ],
              "httpsPorts": [
                "text"
              ],
              "id": 1,
              "name": "text",
              "isGateway": true,
              "isCloudAgent": true
            }
          ]
        }
      ],
      "internalName": "text"
    }
  ]
}

Get single Environment

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

environmentIdinteger · int64Required

Environment Identifier

Responses

200

OK

application/json

404

Environment not found

application/problem+json

get

/api/v1/environments/{environmentId}

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environmentId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "displayName": "text",
    "agentGroups": [
      {
        "id": 1,
        "displayName": "text",
        "internalName": "text",
        "isCrossPlatform": true,
        "agents": [
          "text"
        ],
        "environment": {
          "id": 1,
          "displayName": "text"
        },
        "agentDetails": [
          {
            "url": "text",
            "httpPorts": [
              "text"
            ],
            "httpsPorts": [
              "text"
            ],
            "id": 1,
            "name": "text",
            "isGateway": true,
            "isCloudAgent": true
          }
        ]
      }
    ],
    "internalName": "text"
  }
}

List Agent Groups for Environment

get

Authorizations

bearerAuth

AuthorizationstringRequired

Enter your bearer token in the format Bearer <token>

Path parameters

environmentIdinteger · int64Required

Environment Identifier

Responses

200

OK

application/json

404

Environment not found

application/problem+json

get

/api/v1/environments/{environmentId}/agent-groups

HTTPcURLJavaScriptPython

GET /api/v1/environments/{environmentId}/agent-groups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "displayName": "text",
      "internalName": "text",
      "isCrossPlatform": true,
      "agents": [
        "text"
      ],
      "environment": {
        "id": 1,
        "displayName": "text"
      },
      "agentDetails": [
        {
          "url": "text",
          "httpPorts": [
            "text"
          ],
          "httpsPorts": [
            "text"
          ],
          "id": 1,
          "name": "text",
          "isGateway": true,
          "isCloudAgent": true
        }
      ]
    }
  ]
}