MetriBeacon
Menu

GET Read SSL certificate details

/api/v1/monitors/{id}/tls

Read bounded, location-bound certificate evidence. Automatic certificate diagnostics and remaining-day measurements run hourly; domain diagnostics run daily. Rechecks require edit rights, a saved target, the current configuration revision and an operation id. They use check quotas without changing regular HTTP measurements or alarm confirmations. Unknown or stale evidence does not confirm validity.

On this page

Access and permissions

Read bounded, location-bound certificate evidence. Automatic certificate diagnostics and remaining-day measurements run hourly; domain diagnostics run daily. Rechecks require edit rights, a saved target, the current configuration revision and an operation id. They use check quotas without changing regular HTTP measurements or alarm confirmations. Unknown or stale evidence does not confirm validity.

Browser session: __Host-mb_session cookie.

Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource ID in this workspace
location_idURL querystring; {"format":"uuid"}NoChoose a configured location to read its certificate. Omit this parameter to read the certificate with the shortest remaining lifetime. The summary always covers every configured location.

Request body

No request body.

Responses

Stable error codes
invalid_session

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
csrf
forbidden
insufficient_scope

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
not_found

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_monitor

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
query_limit

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
unavailable

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—

application/json

FieldType and limitsRequiredMeaning
$MonitorTLSYes—
$.monitor_idstring; {"format":"uuid"}Yes—
$.config_revisionintegerYes—
$.pausedbooleanYes—
$.urlstringYes—
$.certificatesarray<MonitorTLSEvidence>; {"maxItems":1}Yes—
$.certificates[]MonitorTLSEvidenceYes—
$.certificates[].location_idstring; {"format":"uuid"}Yes—
$.certificates[].location_namestringYes—
$.certificates[].certificateTLSSnapshotYes—
$.certificates[].certificate.hoststring; {"maxLength":253}Yes—
$.certificates[].certificate.tls_versionstringYes—
$.certificates[].certificate.chainarray<TLSCertificate>; {"minItems":1,"maxItems":16}Yes—
$.certificates[].certificate.chain[]TLSCertificateYes—
$.certificates[].certificate.chain[].sha256string; {"pattern":"^[a-f0-9]{64}$"}Yes—
$.certificates[].certificate.chain[].common_namestring; {"maxLength":256}Yes—
$.certificates[].certificate.chain[].issuerstring; {"maxLength":256}Yes—
$.certificates[].certificate.chain[].serialstring; {"maxLength":128}Yes—
$.certificates[].certificate.chain[].not_beforestring; {"format":"date-time"}Yes—
$.certificates[].certificate.chain[].not_afterstring; {"format":"date-time"}Yes—
$.certificates[].certificate.chain[].namesarray<string; {"maxLength":253}>; {"maxItems":128}Yes—
$.certificates[].certificate.chain[].names[]string; {"maxLength":253}Yes—
$.certificates[].certificate.chain[].is_cabooleanYes—
$.certificates[].certificate.chain[].sentbooleanYes—
$.certificates[].certificate.chain[].signaturestringYes—
$.certificates[].certificate.chain[].keystringYes—
$.certificates[].certificate.checksarray<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7}Yes—
$.certificates[].certificate.checks[]object; {"additionalProperties":false}Yes—
$.certificates[].certificate.checks[].keystring; {"enum":["validity","hostname","authority","chain","revocation","tls","strength"]}Yes—
$.certificates[].certificate.checks[].statusstring; {"enum":["passed","failed","unknown"]}Yes—
$.certificates[].certificate.checks[].reasonstring; {"maxLength":64}Yes—
$.certificates[].certificate.revocation_valid_untilstring; {"format":"date-time"}No—
$.certificates[].certificate.truncatedbooleanNo—
$.certificates[].certificate.portinteger; {"minimum":1,"maximum":65535}No—
$.certificates[].first_seen_atstring; {"format":"date-time"}Yes—
$.certificates[].observed_atstring; {"format":"date-time"}Yes—
$.certificates[].diagnosed_atstring; {"format":"date-time"} | nullYes—
$.certificates[].diagnosed_at (anyOf 1)string; {"format":"date-time"}No—
$.certificates[].diagnosed_at (anyOf 2)nullNo—
$.certificates[].config_revisionintegerYes—
$.locationsarray<object; {"additionalProperties":false}>Yes—
$.locations[]object; {"additionalProperties":false}Yes—
$.locations[].idstring; {"format":"uuid"}Yes—
$.locations[].namestringYes—
$.domainobject; {"additionalProperties":true} | nullYes—
$.domain (anyOf 1)object; {"additionalProperties":true}No—
$.domain (anyOf 2)nullNo—
$.domain_observed_atstring; {"format":"date-time"} | nullYes—
$.domain_observed_at (anyOf 1)string; {"format":"date-time"}No—
$.domain_observed_at (anyOf 2)nullNo—
$.alertingobject; {"additionalProperties":true} | nullYes—
$.alerting (anyOf 1)object; {"additionalProperties":true}No—
$.alerting (anyOf 2)nullNo—
$.alerting_revisionintegerYes—
$.diagnostic_interval_secondsintegerYes—
$.summaryobject; {"additionalProperties":false}Yes—
$.summary.not_afterstring; {"format":"date-time"} | nullYes—
$.summary.not_after (anyOf 1)string; {"format":"date-time"}No—
$.summary.not_after (anyOf 2)nullNo—
$.summary.not_beforestring; {"format":"date-time"} | nullYes—
$.summary.not_before (anyOf 1)string; {"format":"date-time"}No—
$.summary.not_before (anyOf 2)nullNo—
$.summary.observed_atstring; {"format":"date-time"} | nullYes—
$.summary.observed_at (anyOf 1)string; {"format":"date-time"}No—
$.summary.observed_at (anyOf 2)nullNo—
$.summary.failedbooleanYes—
$.summary.stalebooleanNo—
$.diagnosticobject | nullNo—
$.diagnostic.statusstringYes—
$.diagnostic.codestringYes—
$.diagnostic.observed_atstring; {"format":"date-time"}Yes—
$.domain_diagnosticobject | nullNo—
$.domain_diagnostic.statusstringYes—
$.domain_diagnostic.codestringYes—
$.domain_diagnostic.observed_atstring; {"format":"date-time"}Yes—

Retries and asynchronous work

This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

shell
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" --request GET --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/tls"
python
import http.client, json
from pathlib import Path

headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
headers["Content-Type"] = "application/json"
connection = http.client.HTTPSConnection("metribeacon.com", timeout=10)
connection.request('GET', '/api/v1/monitors/00000000-0000-4000-8000-000000000001/tls', body=None, headers=headers)
response = connection.getresponse()
print(response.status)
connection.close()
javascript
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";

const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
headers["Content-Type"] = "application/json";
const response = await fetch("https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/tls", {method: "GET", headers, redirect: "error", signal: AbortSignal.timeout(10000)});
console.log(response.status);
await response.body?.cancel();
go
package main

import ("fmt"; "net/http"; "time"; "encoding/json"; "os"; "path/filepath")

func main() {
 home, err := os.UserHomeDir(); if err != nil { panic("credentials unavailable") }
 raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("credentials unavailable") }
 var headers map[string]string
 if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
 request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/tls", nil); if err != nil { panic("request invalid") }
 for name, value := range headers { request.Header.Set(name, value) }
 request.Header.Set("Content-Type", "application/json")
 client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
 response, err := client.Do(request); if err != nil { panic("request failed") }
 defer response.Body.Close()
 fmt.Println(response.StatusCode)
}
  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • POST Recheck an SSL certificate

    Start a revision-bound, TLS-only certificate diagnosis at one saved monitor location. Requires write access and available checker capacity; it does not resend the HTTP request or change regular telemetry. Reuse the operation ID when retrying.

  • GET Read certificate recheck status

    Read the status and completion time of your certificate recheck for this monitor. A completed diagnostic does not confirm availability; retrieve the TLS view for its current certificate evidence.

  • GET Read the monitor’s aggregate availability source

    HTTP and TCP, UDP, DNS, TLS, ping, service, domain and browser monitors use one aggregate availability series per monitor. For multiple checking locations, this series follows the monitor’s configured confirmation and any/all/quorum policy. Per-location and per-engine durations are never added together. The catalog includes active monitors with availability collection enabled; the individual source also exposes retained history when collection is disabled. Unknown, paused and unobserved time never count as confirmed availability. SLOs and reports use the same source and retain their separate maintenance calculations.