Installation

Get a specific environment

Changed on

Get a specific environment.

User must be authenticated.

get/environments/{envId}

Request

  • Base URL
    /management/v2 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/{envId}
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Response

An environment

idstring

Environment's uuid.

namestring

Environment's name. Duplicate names can exists.

descriptionstring

Environment's description. A short description of your Environment.

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "name": "My Environment",
  "description": "I can use many characters to describe this Environment."
}

Changes

    • breaking

      the // response's property type changed from object to no type for status