GET /API/Maintenance/

Basic Intro

Returns your existing maintenance windows from your account. NOTE: Authentication and a valid plan required

Parameters
Parameter Type Restrictions Description Required
id Integer - The ID of the window - Leave empty to retrieve all tests No
state String Valid: [ALL, PND, ACT, END, CNC] Filter tests based on state. Default: ALL No

Response Codes

Success

  • HTTP 200 - Success - Results can be found in the output

User Error

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

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

Result of request without ID.
{
    "success": true,            // Returns false on error
    "message": "",              // Additional information, if available
    "data": [
        {
            "id": 25,                           // Unique window ID
            "name": "Scheduled Nightly",        // Name of the window
            "start_utc": "2016-12-19 11:02:15", // Start time in UTC timezone
            "end_utc": "2016-12-19 11:02:14",   // End time in UTC timezone
            "recur_every": 0,                   // How often this window recurds
            "all_tests": [                      // Combined array of Test IDs of all raw tests and tags
                "123451",
                "123452",
                "123453",
            ],
            "raw_tests": [                      // Array of Test IDs of raw tests
                "123451",
                "123452",
                "123453",
            ],
            "raw_tags": [],                     // Array of tags
            "state": "Ended",                   // Current window state
            "timezone": "UTC",                  // Timezone applying to the window
            "follow_dst": false                 // Whether to follow DST or not.
        },
        { … }
    ]
}
Result of request with ID.
{
    "success": true,            // Returns false on error
    "message": "",              // Additional information, if available
    "data": {
            "id": 25,                           // Unique window ID
            "name": "Scheduled Nightly",        // Name of the window
            "start_utc": "2016-12-19 11:02:15", // Start time in UTC timezone
            "end_utc": "2016-12-19 11:02:14",   // End time in UTC timezone
            "recur_every": 0,                   // How often this window recurds
            "all_tests": [                      // Combined array of Test IDs of all raw tests and tags
                "123451",
                "123452",
                "123453",
            ],
            "raw_tests": [                      // Array of Test IDs of raw tests
                "123451",
                "123452",
                "123453",
            ],
            "raw_tags": [],                     // Array of tags
            "state": "Ended",                   // Current window state
            "timezone": "UTC",                  // Timezone applying to the window
            "follow_dst": false                 // Whether to follow DST or not.
        },
}