POST /API/Maintenance/Update

Basic Intro

Update an existing maintenance window on your account.
NOTE: Authentication and a valid plan required

Parameters

ID is required, without it a new window will be created! Optional parameters should not be included if they are to remain unchanged, include but leave empty to erase them

Parameter Type Default Restrictions Description Required
id Integer - - The unique id of the maintenance window to edit YES
name String - - A descriptive name for your maintenance window No
start_unix Integer - Valid UNIX timestamp Start date of your window. Can be slightly in the past No
end_unix Integer - Valid UNIX timestamp End time of your window. Must be in the future No
timezone String - Valid Timezone Must be a valid timezone, or UTC No
raw_tests String - Comma separated string of Test IDs Individual tests that should be included No
raw_tags String - Comma separated string of Tags Tests with these tags will be included No
recur_every Integer - Options: [0, 1, 7, 14, 30] How often this window should recur. 0 disables this No
follow_dst Boolean - True / False Whether DST should be followed or not No

NOTE: You can only update a window if it isn't active or finished.

Response Codes

Success

  • HTTP 200 - Success - The maintenance window has been updated successfully.

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 POST.

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
}