Skip to main content
PUT
/
api
/
v1
/
maintenance-windows
/
{id}
Update a maintenance window
curl --request PUT \
  --url https://api.devhelm.io/api/v1/maintenance-windows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repeatRule": "<string>",
  "reason": "<string>",
  "suppressAlerts": true
}
'
import requests

url = "https://api.devhelm.io/api/v1/maintenance-windows/{id}"

payload = {
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repeatRule": "<string>",
    "reason": "<string>",
    "suppressAlerts": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    startsAt: '2023-11-07T05:31:56Z',
    endsAt: '2023-11-07T05:31:56Z',
    monitorId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    repeatRule: '<string>',
    reason: '<string>',
    suppressAlerts: true
  })
};

fetch('https://api.devhelm.io/api/v1/maintenance-windows/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devhelm.io/api/v1/maintenance-windows/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'startsAt' => '2023-11-07T05:31:56Z',
    'endsAt' => '2023-11-07T05:31:56Z',
    'monitorId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'repeatRule' => '<string>',
    'reason' => '<string>',
    'suppressAlerts' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devhelm.io/api/v1/maintenance-windows/{id}"

	payload := strings.NewReader("{\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"repeatRule\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"suppressAlerts\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.devhelm.io/api/v1/maintenance-windows/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"repeatRule\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"suppressAlerts\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.devhelm.io/api/v1/maintenance-windows/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startsAt\": \"2023-11-07T05:31:56Z\",\n  \"endsAt\": \"2023-11-07T05:31:56Z\",\n  \"monitorId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"repeatRule\": \"<string>\",\n  \"reason\": \"<string>\",\n  \"suppressAlerts\": true\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": 123,
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "suppressAlerts": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repeatRule": "<string>",
    "reason": "<string>"
  }
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}
{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "Monitor not found",
  "timestamp": 1737302400000,
  "requestId": "5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Body

application/json
startsAt
string<date-time>
required

Updated start time (ISO 8601)

endsAt
string<date-time>
required

Updated end time (ISO 8601)

monitorId
string<uuid> | null

Monitor this window applies to; null switches the window to org-wide

repeatRule
string | null

Reserved: iCal RRULE for recurring windows (stored but not yet honored); null clears it

Maximum string length: 100
reason
string | null

Updated reason (max 500 chars); null clears the existing reason

Maximum string length: 500
suppressAlerts
boolean | null

Whether to suppress alerts during this window; null defaults to true

Response

OK

data
object
required

Scheduled maintenance window for a monitor