Get Environment Details by ID

get

/environment/{id}

Retrieves the specified environment.

Request

Path Parameters
Query Parameters
  • Set this parameter to true to expand environment details.
Back to Top

Response

200 Response

The environment details were retrieved succesfully.
Back to Top

Examples

The following example shows how to retrieve details of an environment by ID 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/5" -H "accept: */*"

Example of Response Body

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

{
  "_id": 5,
  "name": "update----environment-100",
  "count": 1,
  "connections": [
    {
      "_id": 29,
      "name": "test-update1",
      "properties": [
        {
          "_id": 274923071405041,
          "name": "name--2",
          "value": "value--2"
        },
        {
          "_id": 274923071784208,
          "name": "name--2",
          "value": "value--2"
        },
        {
          "_id": 274923071789083,
          "name": "name--3",
          "value": "value--3"
        },
        {
          "_id": 274923071792791,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071796166,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071799541,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071802875,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071806083,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071809333,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071812541,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 274923071815625,
          "name": "name--1",
          "value": "value--1"
        },
        {
          "_id": 357844231324209,
          "name": "new-name--1",
          "value": "newvalue"
        },
        {
          "_id": 357844231328042,
          "name": "new-name--1",
          "value": "newvalue"
        }
      ],
      "description": "connecction--1-100 description"
    }
  ],
  "description": "environment 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