Try the RankNibbler SEO API

Setting options Beta

GET /api/v1/monitors/options

The allowed values for every setting, and the defaults a new monitor gets. Use it to build a form, or to check a value before you send it.

Needs an X-API-Key header whose owner has access to uptime monitoring in the app. The call counts once against your daily quota. See Monitoring API: getting started for authentication, rate limits and errors.

Request

Response

200 · application/json
  1. {
  2. "types": [
  3. { "value": "http", "label": "Website", "needsHost": false, "needsPort": false,
  4. "defaultPort": null, "tlsPort": null, "encryption": false },
  5. { "value": "tcp", "label": "TCP port", "needsHost": true, "needsPort": true, … },
  6. { "value": "smtp", "label": "Mail server (SMTP)", "needsHost": true, "needsPort": false,
  7. "defaultPort": 25, "tlsPort": 465, "encryption": true }, …
  8. ],
  9. "dnsRecordTypes": ["A", "AAAA", "CNAME", "MX", "TXT", "NS", "SOA"],
  10. "encryptions": ["none", "tls", "starttls"],
  11. "pingAvailable": true,
  12. "intervals": [1, 5, 15, 30, 60],
  13. "regionMinInterval": 15,
  14. "regions": [
  15. { "code": "default", "label": "Default", "available": true, … },
  16. { "code": "na", "label": "North America", "detail": "Checked from the United States", "available": true },
  17. { "code": "eu", "label": "Europe", "detail": "Checked from Europe", "available": true },
  18. { "code": "apac", "label": "Asia Pacific", "detail": "Unavailable on your plan", "available": false },
  19. { "code": "latam", "label": "Latin America", "detail": "Unavailable on your plan", "available": false }
  20. ],
  21. "timeouts": [5, 10, 15, 20, 30],
  22. "alertAfter": [0, 1, 2, 3, 5, 10, 15, 30, 60],
  23. "resendEvery": [0, 5, 10, 15, 30, 60, 120, 360, 1440],
  24. "sslDownDays": [0, 1, 3, 7, 14, 30],
  25. "importance": ["high", "low"],
  26. "defaults": {
  27. "name": "", "url": "", "intervalMinutes": 15, "regions": ["default"], "tags": [],
  28. "timeoutSeconds": 30, "shouldContain": "", "shouldNotContain": "", "postData": "",
  29. "requestHeaders": [], "authUsername": "", "hasAuthPassword": false,
  30. "verifyCertificate": true, "sslDownDays": 0, "importance": "high", "recipients": [],
  31. "alertAfterMinutes": 0, "resendEveryMinutes": 0, "notifyBackUp": true, "alertMessage": ""
  32. },
  33. "usage": { "used": 20, "dailyLimit": 100, "tier": "free" }
  34. }

types lists every check type: needsHost means it takes a bare host rather than a URL, needsPort that you must send a port, defaultPort and tlsPort the standard ports, and encryption whether the type takes an encryption setting. pingAvailable is false when this checking server has no ICMP, so a ping check would report that rather than an outage.

Only choose a region whose available is true. defaults.recipients is empty here, but a monitor created through the API alerts the key's owner unless you send recipients.

Errors

StatusWhen
401The API key is missing or invalid.
403The key's owner doesn't have access to uptime monitoring, or the key isn't linked to a workspace.
405The endpoint doesn't accept that method.
429A rate limit or your daily quota was hit. Read Retry-After, in seconds.
500Something went wrong on our side. Try again.
503The API is temporarily unavailable. Try again shortly.

Errors are JSON: { "error": "message" }. See Monitoring API errors.

Related

← Previous
Bulk delete monitors