Get a TLS monitor.

GET

/tls/job/{tls_job_id}

const url = 'https://api.siteqwality.com/tls/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/tls/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns the TLS monitor associated with an HTTP monitor’s domain.

Authorizations

bearer_auth

Parameters

Path Parameters

tls_job_id

required

string format: uuid

TLS monitor identifier

Responses

200

TLS monitor retrieved

application/json

object

required

string format: uuid

account_id

required

string format: uuid

http_job_id

required

string format: uuid

current_status

required

string

Allowed values: good bad unknown

domain

required

string

expiry_date

string | null format: date-time

last_run_at

string | null format: date-time

last_status_change_at

string | null format: date-time

created_at

required

string format: date-time

port

required

Port the TLS check connects to.

integer format: int32

alert_on_invalid_certificate

required

Whether an invalid certificate alerts.

boolean

certificate_problem

One of:

string
null

Why a browser would reject the certificate, from the latest check that could tell. null when it is valid or has not been judged yet.

string

Allowed values: expired not_yet_valid self_signed untrusted_chain hostname_mismatch

certificate_checked_at

When the certificate was last judged, by an uptime check or this TLS check.

string | null format: date-time

certificate_problem_since

When the current problem was first seen.

string | null format: date-time

Example

{
  "current_status": "good",
  "certificate_problem": "expired"
}

401

Missing or invalid authentication

404

TLS monitor not found

500

Internal server error