Set maintenance mode

Description

Enable or disable maintenance mode for a specific monitoring check.


Parameters

Name Data Type Status Description
auth-id or sub-auth-id or sub-auth-user Integer Required Authentication parameter
auth-password String Required Authentication parameter
id Integer Required The ID of the monitoring check
mode String Required

Set to 1 to enable the mode or 0 to disable.

from String Required

The Unix timestamp when the maintenance period starts.

to String Required

The Unix timestamp when the maintenance period ends.


Return: Array with status and status description


Errors

When the authenctication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

Note: These are example errors in JSON format.


Example

URL JSON: https://api.cloudns.net/monitoring/set-maintenance-mode.json
POST/GET:
auth-id=0&auth-password=password&id=1&mode=0&from=1790163019&to=1790163139
sub-auth-id=0&auth-password=password&id=1&mode=0&from=1790163019&to=1790163139

URL XML: https://api.cloudns.net/monitoring/set-maintenance-mode.xml
POST/GET:
auth-id=0&auth-password=password&id=1&id=1&mode=0&from=1790163019&to=1790163139
sub-auth-id=0&auth-password=password&id=1&id=1&mode=0&from=1790163019&to=1790163139


Last modified: 2026-11-03
We value your privacy! We use cookies to enhance your browsing experience, and analyze our traffic. By clicking "Accept All", you consent to our use of cookies. Cookie Policy.