Installation

List all environments.

Changed on

List all environments accessible by the current user.

User must be authenticated.

get/environments

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
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

Response

Page of environments

metadataMetadataResponse

Generic object to handle additional information about an entity. Can also be used for pagination data.

Example response

{
  "data": [
    {
      "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