Skip to content

TLS check reference

The full request/response schema is in the auto-generated API Reference. This page is the human-readable cheat sheet.

FieldTypeDescription
iduuidTLS check ID.
account_iduuidOwning account.
http_job_iduuidThe HTTP check this TLS check was paired with on creation.
current_statusenumSee status table below.
domainstringHostname extracted from the HTTP check’s URL.
expiry_daterfc3339 | nullCert’s notAfter (set after first successful handshake).
last_run_atrfc3339 | nullMost recent handshake timestamp.
last_status_change_atrfc3339 | nullWhen current_status last transitioned.
created_atrfc3339When the TLS check was first provisioned.
StatusMeaning
healthyMost recent handshake succeeded; cert valid, chain trusted, hostname matches, expiry > warning threshold.
pending_failureOne handshake failed; the next will confirm. Suppresses alerts on transient blips.
failedTwo consecutive handshake failures: chain invalid, hostname mismatch, or cert expired. Triggers notifications.
expiring_soonCert is valid but expiry is within the warning window (default 14 days).

The TLS check is read-only via its own endpoints (you create it implicitly by setting monitor_tls: true on an HTTP check):

MethodPathPurpose
GET/tls/job/{tls_job_id}Fetch current status.
GET/tls/job/{tls_job_id}/recentRecent handshake results.

To enable/disable TLS monitoring, PUT /http/job/{job_id} with monitor_tls: true|false.