API documentation — StatusCake

Cited by

Facts read from this source

• API base URL Report an error

  “StatusCake API endpoints to manage monitoring resources.”

• API auth Report an error

  “curl https://api.statuscake.com/v1/heartbeat \ -H "Authorization: Bearer ${API_TOKEN}"”

• Openapi available Report an error

  “Download OpenAPI specification:Download”

• API license Report an error

  “License: Apache-2.0”

• API support email Report an error

  “Support: support@statuscake.com”

• API ratelimiting Report an error

  “Documentation on API ratelimiting can be found here.”

• API error handling Report an error

  “Documentation on error handling can be found here.”

• Heartbeat API Report an error

  “The Heartbeat API provides methods to operate on heartbeat resources, effectively allowing checks to be read and listed.”

• Pagespeed API Report an error

  “The Pagespeed API provides methods to operate on pagespeed resources, effectively allowing checks to be created, read, updated, and deleted. In addition the history of a specific pagespeed check can be returned for a given period.”

• Pagespeed check rate Report an error

  “check_rate required integer (PagespeedTestCheckRate) Enum: 60 300 600 900 1800 3600 86400”

• Pagespeed regions Report an error

  “Enum: "AU" "CA" "DE" "FR" "IN" "JP" "NL" "SG" "UK" "US" "USW" Region on which to run checks”

• Pagespeed alerts Report an error

  “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.”

• Ssl API Report an error

  “The SSL API provides methods to operate on SSL resources, effectively allowing checks to be created, read, updated, and deleted.”

• Ssl check rate Report an error

  “check_rate required integer (SSLTestCheckRate) Enum: 300 600 1800 3600 86400 2073600”

• Ssl alert types Report an error

  “alert_broken boolean Default: false Whether to enable alerts when SSL certificate issues are found alert_expiry boolean Default: false Whether to enable alerts when the SSL certificate is to expire alert_mixed boolean Default: false Whether to enable alerts when mixed content is found alert_reminder boolean Default: false Whether to enable alert reminders”

• Ssl mixed content reporting Report an error

  “mixed_content required Array of objects (SSLTestMixedContent) List of mixed content resources”

• Ssl certificate details Report an error

  “certificate_score integer <int32> [ 0 .. 100 ] SSL certificate score (%)”

• Uptime API Report an error

  “The Uptime API provides methods to operate on uptime resources, effectively allowing checks to be created, read, updated, and deleted. In addition the Uptime API is able to return a history of uptime status for a given period; and return a history of alerts since a given date.”

• Uptime test types Report an error

  “test_type required string (UptimeTestType) Enum: "DNS" "HEAD" "HTTP" "PING" "SMTP" "SSH" "TCP"”

• Uptime check rate Report an error

  “check_rate required integer (UptimeTestCheckRate) Enum: 0 30 60 300 900 1800 3600 86400”

• Uptime confirmation servers Report an error

  “confirmation integer <int32> [ 0 .. 3 ] Default: 2 Number of confirmation servers to confirm downtime before an alert is triggered”

• Uptime content matching Report an error

  “find_string string String to look for within the response. Considered down if not found”

• Uptime basic auth Report an error

  “basic_username string Basic authentication username basic_password string Basic authentication password”

• Uptime ssl expiry alert Report an error

  “enable_ssl_alert boolean Default: false Whether to send an alert if the SSL certificate is soon to expire”

• Uptime regions Report an error

  “regions Array of strings List of regions on which to run checks. The values required for this parameter can be retrieved from the GET /v1/uptime-locations endpoint.”

• Uptime timeout Report an error

  “timeout integer <int32> [ 5 .. 75 ] Default: 15 The number of seconds to wait to receive the first byte”

• Uptime trigger rate Report an error

  “trigger_rate integer <int32> [ 0 .. 60 ] Default: 0 The number of minutes to wait before sending an alert”

• Uptime periods endpoint Report an error

  “Get all uptime check periods Returns a list of uptime check periods for a given id, detailing the creation time of the period, when it ended and the duration.”

• Maintenance windows API Report an error

  “The Maintenance Windows API provides methods to pause alerts from being sent for scheduled maintenance periods.”

• Maintenance windows repeat Report an error

  “repeat_interval string (MaintenanceWindowRepeatInterval) Enum: "never" "1d" "1w" "2w" "1m"”

• Maintenance window scope Report an error

  “tags Array of strings List of tags used to include matching uptime checks in this maintenance window. At least one of tests and tags must be present in the request”

• Maintenance windows new version only Report an error

  “the API endpoints concerned with maintenance windows will only work with accounts registed to use the newer version of maintenance windows.”

• API tag filtering Report an error

  “tags string Comma separated list of tags assocaited with a check”

1 fact read from this page is not shown because it could not be confirmed on the page as captured.

Scores citing this record

• The Agency Developer Checks, locations & failure confirmation
• The Agency Developer Alerting, escalation & on-call
• The Agency Developer API, monitoring as code & team administration
• The Agency Developer Uptime reports, data & the vendor's own reliability
• The Customer Support Lead Checks, locations & failure confirmation
• The Customer Support Lead Alerting, escalation & on-call
• The Customer Support Lead API, monitoring as code & team administration
• The E-Commerce Operations Manager Checks, locations & failure confirmation
• The E-Commerce Operations Manager Alerting, escalation & on-call
• The E-Commerce Operations Manager API, monitoring as code & team administration
• The SaaS Platform Engineer Checks, locations & failure confirmation
• The SaaS Platform Engineer Alerting, escalation & on-call
• The SaaS Platform Engineer API, monitoring as code & team administration
• The Information Security Officer Checks, locations & failure confirmation
• The Information Security Officer Alerting, escalation & on-call
• The Information Security Officer API, monitoring as code & team administration
• The Information Security Officer Uptime reports, data & the vendor's own reliability
• The Skeptic Checks, locations & failure confirmation
• The Skeptic Alerting, escalation & on-call
• The Skeptic API, monitoring as code & team administration
• The Skeptic Uptime reports, data & the vendor's own reliability