Maintenance windows API - GET all maintenance windows

Lists all maintenance windows available in your Dynatrace environment.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/maintenanceWindows
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/maintenanceWindows

Authentication

To execute this request, you need the Read configuration (ReadConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response format

The StubList object

An ordered list of short representations of Dynatrace entities.

Element Type Description
values EntityShortRepresentation[]

An ordered list of short representations of Dynatrace entities.

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

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.dynatrace.com/api/config/v1/maintenanceWindows \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/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