Environments

Information about the environment

Fetch information about an environment.

get/_api/environments/{environment}/metadata

Request

Path parameters

environmentstring string required

The Database name for which we want the information.

Response

Successfully fetched the information for the environment.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "result": {
    "name": "_system",
    "options": {
      "associated_regions": [
        "datacenter1",
        "datacenter2"
      ],
      "clusters": [
        "datacenter1",
        "datacenter2"
      ],
      "dcList": "datacenter1,datacenter2",
      "metadata": {
        "key": "value"
      },
      "name": "_system",
      "spotDc": "datacenter1",
      "status": "available",
      "tenant": "_mm"
    },
    "isSystem": true
  }
}

Changes

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