Raw schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Name of the check."
},
"test_type": {
"type": "string",
"enum": [
"HTTP",
"HEAD",
"TCP",
"DNS",
"SMTP",
"SSH",
"PING"
],
"description": "Check type: HTTP, HEAD, TCP, DNS, SMTP, SSH or PING."
},
"website_url": {
"type": "string",
"minLength": 1,
"description": "URL, FQDN or IP address to check."
},
"check_rate": {
"type": "number",
"enum": [
0,
30,
60,
300,
900,
1800,
3600,
86400
],
"description": "Seconds between checks: 0, 30, 60, 300, 900, 1800, 3600 or 86400."
},
"contact_groups": {
"description": "Contact group ids to alert (see statuscake_list_contact_groups). An empty list clears them.",
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"description": "Tags for the check. An empty list clears them.",
"type": "array",
"items": {
"type": "string"
}
},
"paused": {
"description": "true to pause the check (stops running and alerting), false to resume.",
"type": "boolean"
},
"timeout": {
"description": "Seconds to wait for the first byte, 5-75 (default 15).",
"type": "integer",
"minimum": 5,
"maximum": 75
},
"trigger_rate": {
"description": "Minutes to wait before sending an alert, 0-60 (default 0).",
"type": "integer",
"minimum": 0,
"maximum": 60
},
"confirmation": {
"description": "Number of confirmation servers that must agree before alerting, 0-3 (default 2).",
"type": "integer",
"minimum": 0,
"maximum": 3
},
"regions": {
"description": "Region codes to run the check from (see statuscake_list_uptime_locations).",
"type": "array",
"items": {
"type": "string"
}
},
"find_string": {
"description": "String to look for in the response; the check is down if not found.",
"type": "string"
},
"do_not_find": {
"description": "Invert find_string: the check is down if the string IS present.",
"type": "boolean"
},
"include_header": {
"description": "Include response headers in the find_string search.",
"type": "boolean"
},
"follow_redirects": {
"description": "Follow redirects when testing (off by default).",
"type": "boolean"
},
"final_endpoint": {
"description": "Where the redirect chain should end (with follow_redirects).",
"type": "string"
},
"status_codes_csv": {
"description": "Comma-separated HTTP status codes that count as down, e.g. \"500,502,503\".",
"type": "string"
},
"enable_ssl_alert": {
"description": "Alert when the site's SSL certificate is about to expire.",
"type": "boolean"
},
"user_agent": {
"description": "Custom User-Agent sent with each check.",
"type": "string"
},
"custom_header": {
"description": "JSON object string of headers to send, e.g. {\"X-Env\":\"prod\"}.",
"type": "string"
},
"post_body": {
"description": "JSON object string submitted with the request; setting it makes the check use HTTP POST.",
"type": "string"
},
"post_raw": {
"description": "Raw HTTP POST body to send.",
"type": "string"
},
"basic_username": {
"description": "HTTP basic-auth username for the target.",
"type": "string"
},
"basic_password": {
"description": "HTTP basic-auth password for the target.",
"type": "string"
},
"use_jar": {
"description": "Enable cookie storage between requests.",
"type": "boolean"
},
"port": {
"description": "Destination port (TCP, SMTP, SSH checks).",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"dns_server": {
"description": "Nameserver to query (DNS checks).",
"type": "string"
},
"dns_ips": {
"description": "IP addresses the DNS record must resolve to (DNS checks).",
"type": "array",
"items": {
"type": "string"
}
},
"host": {
"description": "Name of the hosting provider (informational).",
"type": "string"
}
},
"required": [
"name",
"test_type",
"website_url",
"check_rate"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}