Skip to main content
GET
/
api
/
v1
/
services
/
{slugOrId}
/
maintenances
List scheduled maintenances for a service
curl --request GET \
  --url https://api.devhelm.io/api/v1/services/{slugOrId}/maintenances \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "title": "<string>",
      "status": "<string>",
      "affectedComponents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "status": "<string>"
        }
      ],
      "updates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "body": "<string>",
          "displayAt": "2023-11-07T05:31:56Z"
        }
      ],
      "impact": "<string>",
      "shortlink": "<string>",
      "scheduledFor": "2023-11-07T05:31:56Z",
      "scheduledUntil": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hasNext": true,
  "hasPrev": true,
  "totalElements": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Path Parameters

​
slugOrId
string
required

Query Parameters

​
status
string[]

Filter by status (e.g. scheduled, in_progress, verifying, completed)

Response

OK

​
data
object[]
required
​
hasNext
boolean
required
​
hasPrev
boolean
required
​
totalElements
integer<int64> | null
​
totalPages
integer<int32> | null