Maintenance windows API - GET all maintenance windows
Lists all maintenance windows available in your DESK environment.
The request produces an application/json payload.
| GET |
|
Parameters
The request doesn't provide any configurable parameters.
Response format
The StubList object
An ordered list of short representations of DESK entities.
| Element | Type | Description |
|---|---|---|
| values | EntityShortRepresentation[] | An ordered list of short representations of DESK entities. |
The EntityShortRepresentation object
The short representation of a DESK entity.
| Element | Type | Description |
|---|---|---|
| id | string | The ID of the DESK entity. |
| name | string | The name of the DESK entity. |
| description | string | A short description of the DESK entity. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "DESK entity 1",
"description": "DESK entity 1 for the REST API example\n"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "DESK entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Example
In this example, the request asks for a list of all the maintenance windows in the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to three entries.
Curl
curl -X GET \
https://mySampleEnv.live.dexp.ae/api/config/v1/maintenanceWindows \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dexp.ae/api/config/v1/maintenanceWindows
Response body
{
"values": [
{
"id": "0cd96661-07d9-42da-b2cc-19f22bb9f297",
"name": "Planned server downtime",
"description": "We plan to upgrade the server."
},
{
"id": "b2c61cb1-547c-312f-b2ab-fda372516e8f",
"name": "Monthly maintenance",
"description": "Monthly maintenance of the hardware"
},
{
"id": "0c1882ed-8f20-4e04-8505-05bdfb086ae8",
"name": "New app version deployment",
"description": "Deploy new version of the main app"
}
]
}
Response code
200