Get Environment Details

get

/environment

Retrieves all environments.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

The environment details were retrieved successfully.
Back to Top

Examples

The following example shows how to retrieve details of all environments by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

curl -X GET "hostname:port/environment" -H "accept: */*"

Example of Response Body

If successful, the response code 200 is returned with a response body. For example:

{
  "total": 6,
  "limit": 10,
  "offset": 0,
  "page": 1,
  "pages": 1,
  "docs": [
    {
      "_id": 1,
      "name": "Tdaas",
      "build": null,
      "count": 8,
      "release": null,
      "connections": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8
      ],
      "description": null
    },
    {
      "_id": 2,
      "name": "Tdaas",
      "build": null,
      "count": 5,
      "release": null,
      "connections": [
        9,
        10,
        11,
        12,
        13
      ],
      "description": null
    },
    {
      "_id": 3,
      "name": "environment-100",
      "count": 1,
      "connections": [],
      "description": "environment-100 description"
    },
    {
      "_id": 4,
      "name": "environment-100",
      "count": 1,
      "connections": [],
      "description": "environment-100 description"
    },
    {
      "_id": 5,
      "name": "update----environment-100",
      "count": 1,
      "connections": [
        29
      ],
      "description": "environment nfVSoxIWbQUgJLH"
    },
    {
      "_id": 6,
      "name": "environment-100 nfVSoxIWbQUgJLH",
      "build": null,
      "count": 15,
      "release": null,
      "connections": [
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28
      ],
      "description": "environment-100 nfVSoxIWbQUgJLH"
    }
  ]
}

If the request fails, the response includes the appropriate HTTP code. For a 4xx/5xx code, the message body also contains a ProblemDetails structure with the cause attribute set to the appropriate application error.

Back to Top