DELETE /API/Maintenance/Update

Basic Intro

Deletes an existing maintenance window from your account. NOTE: Authentication and a valid plan required

Parameters
Parameter Type Restrictions Description Required
id Integer - The ID of the maintenance window to delete YES
series Boolean - True to cancel the entire series, false to just cancel the one window YES

NOTE: You can not cancel a window that has already been completed.

Example Request

curl -H "API: [APIKey]" -H "Username: [Username]" -X DELETE https://app.statuscake.com/API/Maintenance/Update?id=1234&series=true

Please note that the parameters need to be provided in the URL as DELETE does not allow content in the body.

Response Codes

Success

  • HTTP 200 - Success - The test was deleted.

User Error

  • HTTP 400 - Request Failed - Generic Error: Please check output for more information.
  • HTTP 404 - Not Found - The selected ID was not found on this account.
  • HTTP 405 - Invalid Method - Invalid method used. Only supports DELETE.

Account Issues

  • HTTP 401 - Authorization Required - Provide Correct Username and API key
  • HTTP 402 - Payment Required - You do not have access to this function. Check your account for more information.
  • HTTP 429 - API Usage Limit Exceeded - Your limit was exceeded. Check your account for more information.

Example Output

The output is returned as a json array

{
    "success": true,    // Returns false on error
    "message": "",      // Additional information, if available
    "data":             // Unused       
}