Get an array of environments of an app
Get all environments of the app.
Request
- Base URLhttps://cloud.home.mendix.com/api/v4
- AuthAPI key in header Authorization
Query parameters
Used with pagination and defines the offset.
Used with pagination and defines the maximum number of objects to return.
Defines the attribute used for sorting the response objects and the sorting order. Possible values are name, index, +name, -name, +index, and -index, where + means ascending and - stands for descending. Note: you must use URL encoding for + and - inside the parameter, that is, replace - with %2d and replace + with %2b. For example, you should write +name as %2dname. If the sorting order is not provided, for example, you use name as the attribute, then the default order is ascending. If the query parameter is empty, then the response is sorted by name and the sorting order is ascending.
The value of this parameter can only be package. The query parameter is optional and when you provide it the response will contain the package object of the package deployed in the environment in addition to the environment details.
Response
OK
Example response
{
"environments": [
{
"id": "22064f8f-ee55-438c-9ab2-182f2f8e5f2f",
"appId": "c533ee0b-f7db-4e62-868b-1192d392ccec",
"name": "Test",
"state": "running",
"package": {
"id": "3bda6b5b-f038-4c09-8697-d065446b7084",
"appId": "c533ee0b-f7db-4e62-868b-1192d392ccec",
"modelVersion": "1.3.0.623",
"runtimeVersion": "9.12.0.41679",
"fileName": "MainLine-1.3.0.623.mda",
"fileSize": 42364523
}
}
],
"pagination": {
"offset": 60,
"limit": 20,
"size": 17
}
}Changes
No recorded changes to this operation across all 1 revision of this API.