MetriBeacon
Menu

GET Read monitor notifications

/api/v1/monitors/{id}/alerting

Read the saved outage, expiry and message settings.

On this page

Access and permissions

Read the saved outage, expiry and message settings.

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 UUID from the path. It must exist and be accessible to the acting identity.

Request body

No request body.

Responses

HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/json

FieldType and limitsRequiredMeaning
$MonitorAlertingYes—
$.revisioninteger; {"minimum":0}Yes—
$.settingsMonitorAlertingSettings | nullYes—
$.settings (oneOf 1)MonitorAlertingSettingsNo—
$.settings (oneOf 1).enabledbooleanYes—
$.settings (oneOf 1).reminders_enabledbooleanYes—
$.settings (oneOf 1).include_target_urlbooleanYes—
$.settings (oneOf 1).certificate_enabledbooleanYes—
$.settings (oneOf 1).expiry_remindersbooleanYes—
$.settings (oneOf 1).certificate_changesbooleanYes—
$.settings (oneOf 1).domain_enabledbooleanYes—
$.settings (oneOf 1).delay_secondsinteger; {"minimum":0,"maximum":86400}Yes—
$.settings (oneOf 1).repeat_secondsinteger; {"minimum":1800,"maximum":86400}Yes—
$.settings (oneOf 1).reminder_limitinteger; {"minimum":1,"maximum":4}Yes—
$.settings (oneOf 1).certificate_daysinteger; {"minimum":1,"maximum":3660}Yes—
$.settings (oneOf 1).domain_daysinteger; {"minimum":1,"maximum":3660}Yes—
$.settings (oneOf 1).notification_modestring; {"enum":["all_active","selected"]}Yes—
$.settings (oneOf 1).notification_destination_idsarray<string; {"format":"uuid"}>; {"maxItems":20}Yes—
$.settings (oneOf 1).notification_destination_ids[]string; {"format":"uuid"}Yes—
$.settings (oneOf 1).escalation_policy_idstring | null; {"format":"uuid"}Yes—
$.settings (oneOf 1).severitystring; {"enum":["info","warning","critical"]}Yes—
$.settings (oneOf 1).domainstring; {"maxLength":253}Yes—
$.settings (oneOf 1).warning_notification_modestring; {"enum":["inherit","all_active","selected"]}Yes—
$.settings (oneOf 1).warning_destination_idsarray<string; {"format":"uuid"}>; {"maxItems":20}Yes—
$.settings (oneOf 1).warning_destination_ids[]string; {"format":"uuid"}Yes—
$.settings (oneOf 2)nullNo—
Stable error codes
invalid_selection
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

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—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 422,
  "title": "Demo error",
  "type": "about:blank"
}

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/alerting"
python
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError

headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
request = Request('https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/alerting', data=None, headers=headers, method='GET')
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, request, fp, code, message, headers, target):
        return None

opener = build_opener(NoRedirect())
try:
    with opener.open(request, timeout=10) as response:
        print(response.status)
except HTTPError as error:
    print(error.code)
    error.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"));
const response = await fetch("https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/alerting", {
  method: "GET", headers, redirect: "manual",
  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/alerting", nil); if err != nil { panic("request invalid") }
 for name, value := range headers { request.Header.Set(name, value) }
 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.

  • PUT Save monitor notifications

    Save settings with the current configuration and alerting revisions. Managed alarm rules and resource limits are checked together.

  • DELETE Permanently delete a monitor

    Only the workspace owner may permanently delete a monitor. First request a five-minute configuration-bound preview, then send preview_id, confirm_deletion: true and an Idempotency-Key. Unconfirmed legacy archive requests are rejected. The monitor is immediately blocked; a durable job removes all its database, archive and cache data and cleans linked displays. Read the job until complete; paused jobs show a technical error and retry automatically. Daily quotas and security counters remain unchanged. Previously delivered messages and downloaded files cannot be recalled.

  • GET Read your monitor and configuration

    Read your monitor and configuration.