Basic Intro

Create new SSL tests using this endpoint.

Name Type Description Required
domain String URL to check, has to start with https:// YES
checkrate Integer Checkrate in seconds. Accepted: [300, 600, 1800, 3600, 86400, 2073600] YES
contact_groups String Contactgroup IDs, separated by a comma. Can be an empy string YES
alert_at String When you wish to receive reminders. Must be exactly 3 numeric values seperated by commas YES
alert_expiry Boolean Set to true to enable expiration alerts. False to disable YES
alert_reminder Boolean Set to true to enable reminder alerts. False to disable. Also see alert_at YES
alert_broken Boolean Set to true to enable broken alerts. False to disable YES
alert_mixed Boolean Set to true to enable mixed content alerts. False to disable YES

Response Codes

  • HTTP 200 - Success - Message will contain ID of newly created SSL check
  • HTTP 400 - Request Failed - Please check output for more information
  • HTTP 401 - Authorization Required - Provide Correct Username and API key
  • HTTP 429 - Payment Required - Amount of SSL tests exceeded on account. Check response for more information.

Example Output

The output is returned as a json array

    "Success": true,        // True if success, false is failed
    "Message": 12345,       // Contains ID of new test if successful, reason for failure if failed
    "Input": {              // Parsed input that was used
        "domain": "https://example.com",        // URL to be checked
        "checkrate": 86400,                     // Checkrate in seconds
        "contact_groups": "1000,2000",          // Contactgroups, ID by CSV
        "alert_reminder": false,                // If reminder was enabled
        "alert_expiry": false,                  // If expiration alerts were enabled 
        "alert_broken": false,                  // If broken alerts were enabled
        "alert_at": "59,60,61"                  // Sanitized alert periods