Update an uptime check
statuscake_update_uptime_checkChange an uptime check's settings. Only the fields you pass are changed; list fields (tags, contact_groups, regions, dns_ips) are REPLACED, and an empty list clears them. Pass paused=true to pause a check and paused=false to resume it. StatusCake: PUT /uptime/{test_id}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | Name of the hosting provider (informational). | |
| name | No | New name for the check. | |
| port | No | Destination port (TCP, SMTP, SSH checks). | |
| tags | No | Tags for the check. An empty list clears them. | |
| paused | No | true to pause the check (stops running and alerting), false to resume. | |
| dns_ips | No | IP addresses the DNS record must resolve to (DNS checks). | |
| regions | No | Region codes to run the check from (see statuscake_list_uptime_locations). | |
| test_id | Yes | The uptime check id. | |
| timeout | No | Seconds to wait for the first byte, 5-75 (default 15). | |
| use_jar | No | Enable cookie storage between requests. | |
| post_raw | No | Raw HTTP POST body to send. | |
| post_body | No | JSON object string submitted with the request; setting it makes the check use HTTP POST. | |
| check_rate | No | Seconds between checks: 0, 30, 60, 300, 900, 1800, 3600 or 86400. | |
| dns_server | No | Nameserver to query (DNS checks). | |
| user_agent | No | Custom User-Agent sent with each check. | |
| do_not_find | No | Invert find_string: the check is down if the string IS present. | |
| find_string | No | String to look for in the response; the check is down if not found. | |
| website_url | No | New URL, FQDN or IP address to check. | |
| confirmation | No | Number of confirmation servers that must agree before alerting, 0-3 (default 2). | |
| trigger_rate | No | Minutes to wait before sending an alert, 0-60 (default 0). | |
| custom_header | No | JSON object string of headers to send, e.g. {"X-Env":"prod"}. | |
| basic_password | No | HTTP basic-auth password for the target. | |
| basic_username | No | HTTP basic-auth username for the target. | |
| contact_groups | No | Contact group ids to alert (see statuscake_list_contact_groups). An empty list clears them. | |
| final_endpoint | No | Where the redirect chain should end (with follow_redirects). | |
| include_header | No | Include response headers in the find_string search. | |
| enable_ssl_alert | No | Alert when the site's SSL certificate is about to expire. | |
| follow_redirects | No | Follow redirects when testing (off by default). | |
| status_codes_csv | No | Comma-separated HTTP status codes that count as down, e.g. "500,502,503". |