← Tools Reference

StatusCake

StatusCake integration (Developer Tools). Imported from open-connector.

API key6 toolshttps://api.statuscake.com/v1
GET
statuscake_list_uptime_tests
List uptime tests available in the connected StatusCake account.

/uptime

4 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page number of results to return.
limitintegeroptionalThe number of uptime tests to return per page.
tagsstringoptionalA comma-separated list of tags used to filter uptime tests.
uptimebooleanoptionalWhether the response should include uptime data.
GET
statuscake_get_uptime_test
Get the full configuration and status of a single StatusCake uptime test.

/uptime/{test_id}

1 parameter
ParamTypeRequiredDescription
test_idstringrequiredThe unique identifier of the StatusCake uptime test.
POST
statuscake_create_uptime_test
Create a new StatusCake uptime test.

/uptime

27 parameters
ParamTypeRequiredDescription
hoststringoptionalThe hosting provider name recorded for the uptime test.
namestringrequiredThe human-readable name of the uptime test.
portintegeroptionalThe destination port used for TCP uptime tests.
tagsarrayoptionalTags assigned to the uptime test.
pausedbooleanoptionalWhether the uptime test should be paused.
dns_ipsarrayoptionalThe DNS IP addresses expected from the monitored host.
regionsarrayoptionalThe regions used for the uptime test.
timeoutintegeroptionalThe timeout in seconds before StatusCake marks the probe as failed.
use_jarbooleanoptionalWhether the uptime test stores cookies between requests.
post_rawstringoptionalThe raw HTTP request body sent by StatusCake for POST-based uptime tests.
post_bodystringoptionalA JSON string payload sent by StatusCake when the uptime test uses POST.
test_typestringrequiredThe uptime test type accepted by StatusCake.
check_rateintegerrequiredThe uptime check interval in seconds accepted by StatusCake.
dns_serverstringoptionalThe FQDN or IP address of the DNS server used for DNS uptime tests.
user_agentstringoptionalThe custom user agent string sent by StatusCake when probing the target.
do_not_findbooleanoptionalWhether StatusCake should fail the test when the find_string is present.
find_stringstringoptionalThe string that must be present in the response body for the uptime test to pas…
website_urlstringrequiredThe URL or IP address of the server monitored by the uptime test.
confirmationintegeroptionalThe number of confirmation servers StatusCake uses before alerting.
trigger_rateintegeroptionalThe number of minutes StatusCake waits before sending an alert.
custom_headerstringoptionalA JSON string or object representing the custom headers sent by StatusCake.
basic_passwordstringoptionalThe basic authentication password used by the uptime test.
basic_usernamestringoptionalThe basic authentication username used by the uptime test.
contact_groupsarrayoptionalThe contact group IDs notified by the uptime test.
follow_redirectsbooleanoptionalWhether StatusCake should follow redirects while probing the target.
include_headerbooleanoptionalWhether response headers should be included when matching the response body.
status_codesarrayoptionalThe HTTP status codes considered healthy by the uptime test.
PUT
statuscake_update_uptime_test
Update an existing StatusCake uptime test.

/uptime/{test_id}

28 parameters
ParamTypeRequiredDescription
test_idstringrequiredThe unique identifier of the StatusCake uptime test.
hoststringoptionalThe hosting provider name recorded for the uptime test.
namestringoptionalThe human-readable name of the uptime test.
portintegeroptionalThe destination port used for TCP uptime tests.
tagsarrayoptionalTags assigned to the uptime test.
pausedbooleanoptionalWhether the uptime test should be paused.
dns_ipsarrayoptionalThe DNS IP addresses expected from the monitored host.
regionsarrayoptionalThe regions used for the uptime test.
timeoutintegeroptionalThe timeout in seconds before StatusCake marks the probe as failed.
use_jarbooleanoptionalWhether the uptime test stores cookies between requests.
post_rawstringoptionalThe raw HTTP request body sent by StatusCake for POST-based uptime tests.
post_bodystringoptionalA JSON string payload sent by StatusCake when the uptime test uses POST.
test_typestringoptionalThe uptime test type accepted by StatusCake.
check_rateintegeroptionalThe uptime check interval in seconds accepted by StatusCake.
dns_serverstringoptionalThe FQDN or IP address of the DNS server used for DNS uptime tests.
user_agentstringoptionalThe custom user agent string sent by StatusCake when probing the target.
do_not_findbooleanoptionalWhether StatusCake should fail the test when the find_string is present.
find_stringstringoptionalThe string that must be present in the response body for the uptime test to pas…
website_urlstringoptionalThe URL or IP address of the server monitored by the uptime test.
confirmationintegeroptionalThe number of confirmation servers StatusCake uses before alerting.
trigger_rateintegeroptionalThe number of minutes StatusCake waits before sending an alert.
custom_headerstringoptionalA JSON string or object representing the custom headers sent by StatusCake.
basic_passwordstringoptionalThe basic authentication password used by the uptime test.
basic_usernamestringoptionalThe basic authentication username used by the uptime test.
contact_groupsarrayoptionalThe contact group IDs notified by the uptime test.
follow_redirectsbooleanoptionalWhether StatusCake should follow redirects while probing the target.
include_headerbooleanoptionalWhether response headers should be included when matching the response body.
status_codesarrayoptionalThe HTTP status codes considered healthy by the uptime test.
DELETE
statuscake_delete_uptime_test
Delete a StatusCake uptime test.

/uptime/{test_id}

1 parameter
ParamTypeRequiredDescription
test_idstringrequiredThe unique identifier of the StatusCake uptime test.
GET
statuscake_list_uptime_locations
List available monitoring locations for StatusCake uptime tests.

/uptime-locations