Skip to main content
Statuscake logo
  • Category: server monitoring
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: STATUSCAKE
  • Version: 20261101_00

Tools

Slug: STATUSCAKE_CREATE_CONTACT_GROUPTool to create a contact group for alert notifications in StatusCake. Use when you need to set up a new group of notification recipients for monitoring alerts. The group can include email addresses, mobile numbers, integrations, and a webhook URL. At minimum, provide a name; other notification methods are optional.

Input Parameters

string
required
Name of the contact group. This is a required field.
string
URL or IP address of an HTTP GET endpoint to push uptime events to. Currently only supports HTTP GET endpoints.
array
List of integration IDs to associate with this contact group. Integration IDs can be obtained from your StatusCake integrations.
array
List of international format mobile phone numbers for SMS notifications (e.g., +1234567890).
array
List of email addresses to receive notifications. Each email will be notified when associated tests trigger alerts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_CREATE_HEARTBEAT_TESTTool to create a heartbeat check in StatusCake. Use when you need to set up monitoring for services that send periodic pings. A heartbeat check monitors whether your service is sending regular “heartbeat” pings to StatusCake. If the service fails to send a ping within the specified period, StatusCake will alert you through the configured contact groups. This is ideal for monitoring cron jobs, backup processes, or any scheduled tasks that should run at regular intervals.

Input Parameters

string
Name of the hosting provider or location for organizational purposes.
string
required
Name of the heartbeat check. This is the identifier you’ll see in the StatusCake dashboard.
array
List of tags to assign to the heartbeat check for organization and filtering.
boolean
Whether the check should be paused (not actively monitoring). Set to true to create the check in a paused state. Defaults to false (active monitoring).
integer
required
Number of seconds since the last ping before the check is considered down. Minimum 30 seconds, maximum 172800 seconds (48 hours).
array
List of contact group IDs to notify when the heartbeat check fails. Each ID should be a string (e.g., ‘355190’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_CREATE_PAGESPEED_TESTTool to create a new pagespeed check in StatusCake. Use when you need to set up performance monitoring for a website URL with specific check frequency and region. Returns the ID of the newly created test.

Input Parameters

string
required
Name of the pagespeed check.
boolean
Whether the check should be paused. Default is false (check will run).
string ("AU" | "CA" | "DE" | "FR" | "IN" | "JP" | "NL" | "SG" | "UK" | "US" | "USW")
required
Region on which to run checks. Valid values: AU, CA, DE, FR, IN, JP, NL, SG, UK, US, USW.
integer ("60" | "300" | "600" | "900" | "1800" | "3600" | "86400")
required
Number of seconds between checks. Valid values: 60 (1 minute), 300 (5 minutes), 600 (10 minutes), 900 (15 minutes), 1800 (30 minutes), 3600 (1 hour), 86400 (1 day).
string
required
URL, FQDN, or IP address of the website under test.
integer
An alert will be sent if the size of the page is larger than this value (kb). A value of 0 prevents alerts being sent.
integer
An alert will be sent if the load time of the page exceeds this value (ms). A value of 0 prevents alerts being sent.
integer
An alert will be sent if the size of the page is smaller than this value (kb). A value of 0 prevents alerts being sent.
array
List of contact group IDs to notify on alerts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_CREATE_UPTIME_TESTTool to create a new uptime monitoring check in StatusCake. Use when you need to set up monitoring for a website or server. Supports various check types including HTTP, PING, TCP, DNS, and more. Returns the ID of the newly created test.

Input Parameters

string
Name of the hosting provider.
string
required
Name of the uptime check.
integer
Destination port for TCP checks.
array
List of tags to assign to the test.
boolean
Whether the check should be paused (not run). Default is false.
array
List of IP addresses to compare against returned DNS records (for DNS check type).
array
List of regions on which to run checks. The values can be retrieved from the STATUSCAKE_GET_ALL_LOCATIONS action. If not specified, the API will use default regions.
integer
The number of seconds to wait to receive the first byte (5-75). Default is 15.
boolean
Whether to enable cookie storage. Default is false.
string
Raw HTTP POST string to send to the server.
string
JSON object as string representing the payload submitted with the request. Setting this updates the check to use the HTTP POST verb.
string ("DNS" | "HEAD" | "HTTP" | "PING" | "SMTP" | "SSH" | "TCP")
required
Uptime check type (DNS, HEAD, HTTP, PING, SMTP, SSH, or TCP).
integer ("0" | "30" | "60" | "300" | "900" | "1800" | "3600" | "86400")
required
Number of seconds between checks. Use 0 to pause, 30 for 30s, 60 for 1min, 300 for 5min, 900 for 15min, 1800 for 30min, 3600 for 1hr, 86400 for 1 day.
string
FQDN or IP address of the nameserver to query (for DNS check type).
string
Custom user agent string set when testing.
boolean
Whether to consider the check as down if the find_string content is present within the response. Default is false.
string
String to look for within the response. Considered down if not found.
string
required
URL or IP address of the server under test.
integer
Number of confirmation servers to confirm downtime before an alert is triggered (0-3). Default is 2.
integer
The number of minutes to wait before sending an alert (0-60). Default is 0.
string
JSON object as string representing headers to be sent when making requests (e.g., ’{“User-Agent”: “CustomAgent”}’).
string
Basic authentication password for the target website.
string
Basic authentication username for the target website.
array
List of contact group IDs to notify on status changes.
string
Specify where the redirect chain should end.
boolean
Include header content in string match search. Default is false.
boolean
Whether to send an alert if the SSL certificate is soon to expire. Default is false.
boolean
Whether to follow redirects when testing. Default is false.
string
Comma separated list of status codes that trigger an alert (e.g., ‘400,401,403,404,500’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_DELETE_CONTACT_GROUPTool to delete a contact group. Use when you need to remove an existing contact group by its ID after confirming its existence.

Input Parameters

string
required
The unique identifier of the contact group to delete. Contact group IDs can be retrieved using the Get All Contact Groups action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_DELETE_HEARTBEAT_TESTPermanently deletes a StatusCake heartbeat check. Use this to remove heartbeat monitoring tests that are no longer needed. This operation is irreversible - the heartbeat check and all its historical data will be removed.

Input Parameters

string
required
The unique identifier of the heartbeat check to delete. Obtain this from the STATUSCAKE_GET_HEARTBEAT_CHECKS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_DELETE_PAGESPEED_TESTPermanently deletes a StatusCake PageSpeed test. Use this to remove PageSpeed tests that are no longer needed. This operation is irreversible - the test and all its historical data will be removed. The operation is idempotent - deleting an already-deleted test will still return success.

Input Parameters

string
required
The unique identifier of the PageSpeed test to delete. Obtain this from the STATUSCAKE_GET_ALL_PAGESPEED_TESTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_DELETE_SSL_TESTTool to delete an SSL check with the given ID. Use when you need to permanently remove an SSL monitoring test from StatusCake.

Input Parameters

string
required
The unique identifier of the SSL check to delete. Obtain this from the STATUSCAKE_GET_SSL_CHECKS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_DELETE_TESTPermanently deletes a StatusCake uptime monitoring test. Use this to remove tests that are no longer needed. This operation is irreversible - the test and all its historical data will be removed. The operation is idempotent - deleting an already-deleted test will still return success.

Input Parameters

string
required
The unique identifier (numeric ID) of the uptime test to delete. Obtain this from the STATUSCAKE_GET_ALL_TESTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_ALL_CONTACT_GROUPSLists a page of StatusCake contact groups used for alert notifications. Use the results to find groups and review their notification recipients and integrations; page and limit control pagination.

Input Parameters

integer
Page number for pagination (1-indexed). Defaults to 1 if omitted.
integer
Maximum number of contact groups to return per page (1-100). Defaults to 25 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_ALL_LOCATIONSRetrieves all available uptime monitoring server locations from StatusCake. Use this tool to: - List all monitoring locations to show users available regions - Get region_code values needed when creating or updating uptime checks - Check the current status of monitoring servers - Get IP addresses of monitoring servers for firewall whitelisting Returns ~150 monitoring locations across 30+ countries with their region codes, IP addresses, and availability status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_ALL_PAGESPEED_TESTSLists a page of StatusCake PageSpeed checks for the account. Specify a page and page size to browse existing performance checks; the response includes pagination metadata.

Input Parameters

integer
Page number of results to return (1-based).
integer
Number of results per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_ALL_TESTSLists a page of configured StatusCake uptime checks, with optional tag filtering and pagination. Missing or stale results do not indicate real-time downtime.

Input Parameters

integer
Page number of results to return (1-based).
string
Comma-separated list of tags to filter tests by.
integer
Number of results per page (1-100). Server default is 25.
boolean
Include uptime data if true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_CONTACT_GROUP_DETAILSRetrieves a StatusCake contact group by ID, returning its details for inspecting the group’s alert contacts and integrations.

Input Parameters

string
required
The unique identifier for the contact group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_HEARTBEAT_CHECKSLists a page of heartbeat checks for the StatusCake account. Use pagination to browse the account’s heartbeat monitoring checks and their returned details.

Input Parameters

integer
Page number of results to return (1-based).
integer
Number of results per page (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_HEARTBEAT_TESTTool to retrieve details of a specific heartbeat check. Use when you need configuration and status of a heartbeat test by providing its ID. Example: “Get heartbeat test details for 7884186”.

Input Parameters

string
required
The unique identifier for the heartbeat check to retrieve. Obtain this from the Get Heartbeat Checks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_PAGESPEED_TESTTool to retrieve details of a specific pagespeed check. Use when you need configuration and status of a pagespeed test by providing its ID. Example: “Get pagespeed test details for 122582”.

Input Parameters

string
required
The unique identifier for the pagespeed check to retrieve. Obtain this from the Get All Pagespeed Tests action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_SSL_CHECK_DETAILSRetrieves configuration and status details for a specific StatusCake SSL check by ID. Use it to inspect the check’s monitoring settings and certificate information.

Input Parameters

string
required
The unique identifier for the SSL check to retrieve. Obtain this from the Get SSL Checks action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_SSL_CHECKSRetrieve a paginated list of SSL checks configured in your StatusCake account. Use this action to: - List all SSL certificate monitors - Check certificate statuses across your monitored domains - Review SSL check configurations and alert settings - Get pagination metadata for navigating large result sets Returns SSL check details including certificate validity dates, cipher information, security scores, and alert configuration.

Input Parameters

integer
Page number for pagination (1-based). Defaults to 1 if omitted.
integer
Number of results per page (1-100). Default is 25 if omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_GET_UPTIME_TESTTool to retrieve details of a specific uptime test. Use when you need configuration and status of an uptime check by providing its ID. Example: “Get uptime test details for 7884184”.

Input Parameters

string
required
The unique identifier for the uptime test to retrieve. Obtain this from the Get All Tests action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_LIST_PAGESPEED_MONITORING_LOCATIONSRetrieves all available PageSpeed monitoring server locations from StatusCake. Use when you need to list regions for PageSpeed test configuration or check server availability.

Input Parameters

string
Alpha-2 ISO 3166-1 country code to filter locations by country (e.g., ‘GB’, ‘US’, ‘DE’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_LIST_PAGESPEED_TEST_HISTORYTool to retrieve pagespeed check history for a given test ID. Use when you need to analyze historical performance data for a specific pagespeed test.

Input Parameters

integer
Only results created after this UNIX timestamp will be returned.
integer
The number of results to return from the series. Default is 25.
integer
Only results created before this UNIX timestamp will be returned.
string
required
Pagespeed check ID to retrieve history for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_LIST_UPTIME_TEST_ALERTSTool to retrieve a list of alerts for a specific uptime check. Use when you need to view historical alerts and status changes for an uptime test.

Input Parameters

integer
Only alerts triggered after this UNIX timestamp will be returned.
integer
The number of uptime alerts to return per page. Default is 25.
integer
Only alerts triggered before this UNIX timestamp will be returned.
string
required
Uptime check ID to retrieve alerts for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_LIST_UPTIME_TEST_HISTORYTool to retrieve uptime check history for a given test ID. Use when you need to view historical results of uptime monitoring checks. Supports pagination and time-based filtering.

Input Parameters

integer
Only results created after this UNIX timestamp will be returned.
integer
The number of results to return per page. Server default is 25.
integer
Only results created before this UNIX timestamp will be returned.
string
required
The unique identifier for the uptime test to retrieve history for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_LIST_UPTIME_TEST_PERIODSTool to retrieve a list of uptime check periods for a specific test. Use when you need to view the historical up/down periods for an uptime check.

Input Parameters

integer
Only check periods created after this UNIX timestamp will be returned.
integer
The number of uptime check periods to return per page. Default is 25.
integer
Only check periods created before this UNIX timestamp will be returned.
string
required
Uptime check ID to retrieve periods for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_UPDATE_CONTACT_GROUPUpdates an existing StatusCake contact group’s name, email addresses, mobile numbers, or integrations. Provide at least one change along with the group ID. For a no-content update response, the tool retrieves the updated group details.

Input Parameters

string
New name for the contact group. If not provided, the existing name is preserved.
array
List of integration IDs to associate with the group. Replaces existing integrations when provided.
array
List of mobile phone numbers for SMS notifications. Replaces existing list when provided.
array
List of email addresses for notifications. Replaces existing list when provided.
string
required
Unique identifier of the contact group to update (numeric string, e.g. ‘355190’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_UPDATE_HEARTBEAT_TESTTool to update an existing heartbeat check with new parameters. Use when you need to modify the name, monitoring period, tags, contact groups, host, or pause status of a heartbeat check.

Input Parameters

string
Name of the hosting provider
string
Name of the heartbeat check
array
List of tags to assign to the heartbeat check
boolean
Whether the heartbeat check should be paused (not actively monitoring)
integer
Number of seconds since the last ping before the check is considered down. Must be between 30 and 172800 (48 hours).
string
required
Unique identifier of the heartbeat check to update
array
List of contact group IDs to notify when the heartbeat is missed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_UPDATE_PAGESPEED_TESTUpdates an existing StatusCake PageSpeed check by ID. Use it to change settings such as the monitored website, check frequency, alert thresholds, contact groups, or region; provide at least one setting to make a meaningful change.

Input Parameters

string
Name of the check. If not provided, the existing name is preserved.
boolean
Whether the check should be run. Set to true to pause the check, false to resume it.
string ("AU" | "CA" | "DE" | "FR" | "IN" | "JP" | "NL" | "SG" | "UK" | "US" | "USW")
Region options for pagespeed checks.
string
required
Unique identifier of the pagespeed test to update. Obtain this from the STATUSCAKE_GET_ALL_PAGESPEED_TESTS action.
integer ("60" | "300" | "600" | "900" | "1800" | "3600" | "86400")
Check rate options in seconds.
string
URL, FQDN, or IP address of the website under test. If not provided, the existing URL is preserved.
integer
An alert will be sent if the size of the page is larger than this value (kb). A value of 0 prevents alerts being sent.
integer
An alert will be sent if the load time of the page exceeds this value (ms). A value of 0 prevents alerts being sent.
integer
An alert will be sent if the size of the page is smaller than this value (kb). A value of 0 prevents alerts being sent.
array
List of contact group IDs to notify on alerts. Replaces existing contact groups when provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_UPDATE_SSL_TESTUpdates an existing StatusCake SSL check by ID, including its check frequency, alert preferences, contact groups, and other monitoring settings. For a no-content update response, the tool retrieves the updated check details.

Input Parameters

boolean
Whether to pause the SSL check. Set to true to stop monitoring, false to resume.
string
required
Unique identifier of the SSL check to update. Obtain this from Get SSL Checks action.
array
List of days before certificate expiry to send alerts. Must be exactly 3 numerical values (e.g., [1, 7, 30]).
string
Hostname of the server under test (e.g., ‘example.com’).
integer ("300" | "600" | "1800" | "3600" | "86400" | "2073600")
Check rate interval in seconds.
string
Custom user agent string to use when testing the SSL certificate.
boolean
Whether to enable alerts when mixed content (HTTP resources on HTTPS page) is found.
string
URL of the server to test. Must begin with https:// (e.g., ‘https://example.com’).
boolean
Whether to enable alerts when SSL certificate issues (e.g., expired, broken chain) are detected.
boolean
Whether to enable alerts when the SSL certificate is about to expire.
boolean
Whether to enable alert reminders for this SSL check.
array
List of contact group IDs to notify when alerts are triggered. Replaces existing contact groups when provided.
boolean
Whether to follow HTTP redirects when testing the SSL certificate. Disabled by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STATUSCAKE_UPDATE_UPTIME_TESTUpdates an uptime check with the given parameters. Use when you need to modify configuration of an existing uptime monitoring test such as check frequency, URL, tags, contact groups, or other settings. At least one field besides test_id should be provided to make meaningful changes.

Input Parameters

string
Name of the hosting provider
string
Name of the check
integer
Destination port for TCP checks
array
List of tags to categorize and organize the check
boolean
Whether the check should be run. Set to true to pause the check, false to resume it
array
List of IP addresses to compare against returned DNS records
array
List of regions on which to run checks. The values can be retrieved from the GET /v1/uptime-locations endpoint
string
required
Uptime check ID to update
integer
The number of seconds to wait to receive the first byte (5-75)
boolean
Whether to enable cookie storage
string
Raw HTTP POST string to send to the server
string
JSON object as string representing the payload submitted with the request. Setting this updates the check to use the HTTP POST verb
string ("test_immediately" | "every_30_seconds" | "every_1_minute" | "every_5_minutes" | "every_15_minutes" | "every_30_minutes" | "every_1_hour" | "every_24_hours")
Check rate interval in seconds
string
FQDN or IP address of the nameserver to query
string
Custom user agent string set when testing
boolean
Whether to consider the check as down if the content is present within the response
string
String to look for within the response. Check is considered down if not found
string
URL or IP address of the server under test
integer
Number of confirmation servers (0-3) to confirm downtime before an alert is triggered
integer
The number of minutes to wait before sending an alert
string
JSON object as string representing headers to be sent when making requests
string
Basic authentication password
string
Basic authentication username
array
List of contact group IDs to receive alerts
string
Specify where the redirect chain should end
boolean
Include header content in string match search
boolean
Whether to send an alert if the SSL certificate is soon to expire
boolean
Whether to follow redirects when testing. Disabled by default
string
Comma separated list of status codes that trigger an alert

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not