GET Read the versioned template catalog
/api/v1/templates
Suggestions do not activate alarms automatically. Applying HTTP and run templates also requires the corresponding feature flags.
On this page
Access and permissions
Suggestions do not activate alarms automatically. Applying HTTP and run templates also requires the corresponding feature flags.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
Parameters and headers
No path, query or additional request-header parameters.
Request body
No request body.
Responses
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | Yes | — |
| $.alarm_suggestions_active_by_default | boolean | Yes | — |
| $.apply_available | boolean | Yes | — |
| $.templates | array<object> | Yes | — |
| $.templates[] | object | Yes | — |
| $.templates[].alarm_suggestions | array<object> | Yes | — |
| $.templates[].alarm_suggestions[] | object | Yes | — |
| $.templates[].alarm_suggestions[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.templates[].alarm_suggestions[].series_key | string | No | — |
| $.templates[].alarm_suggestions[].summary | string | Yes | — |
| $.templates[].alarm_suggestions[].summary_key | string | Yes | — |
| $.templates[].id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.templates[].monitor_type | string | Yes | — |
| $.templates[].required_config | array<string> | Yes | — |
| $.templates[].required_config[] | string | Yes | — |
| $.templates[].series | array<object> | Yes | — |
| $.templates[].series[] | object | Yes | — |
| $.templates[].series[].expected_interval_seconds | integer | Yes | Expected sampling interval in seconds. This affects freshness, not whether data is guaranteed to arrive. |
| $.templates[].series[].key | string | Yes | — |
| $.templates[].series[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.templates[].series[].unit | string | Yes | Display unit for a numeric series; it does not automatically convert submitted values. |
| $.templates[].title | string | Yes | Short human-readable label for the response or widget. |
| $.templates[].title_key | string | Yes | — |
| $.templates[].version | integer | Yes | — |
| $.templates[].widgets | array<object> | Yes | — |
| $.templates[].widgets[] | object | Yes | — |
| $.templates[].widgets[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.templates[].widgets[].series_key | string | No | — |
| $.templates[].widgets[].title | string | Yes | Short human-readable label for the response or widget. |
| $.templates[].widgets[].title_key | string | Yes | — |
| $.templates[].chart_presets | ChartPresetRegistry | No | — |
| $.templates[].chart_presets.presets | array<object> | Yes | — |
| $.templates[].chart_presets.presets[] | object | Yes | — |
| $.templates[].chart_presets.presets[].comparison | boolean | No | — |
| $.templates[].chart_presets.presets[].component_kind | string | Yes | — |
| $.templates[].chart_presets.presets[].group | string | Yes | — |
| $.templates[].chart_presets.presets[].id | string; {"enum":["server-overview-cpu","server-overview-memory","server-overview-load","server-disk-total","server-overview-disk","server-overview-network","server-overview-filesystem","cpu-total","cpu-parts","cpu-guest","load","load-core","memory","swap","paging","swap-traffic","filesystem-capacity","filesystem-inodes","filesystem-bytes","filesystem-operations","filesystem-service_time","filesystem-time","disk-bytes","disk-operations","disk-service_time","disk-time","filesystem-states","disk-busy","disk-states","network-traffic","network-packets","network-errors","network-states","container-status","container-restarts","descriptors","uptime","server-overview-swap","server-overview-processes","filesystem-inode-usage","disk-weighted-latency","resource-pressure","oom-killed","storage-pool-health","storage-pool-progress"]} | Yes | — |
| $.templates[].chart_presets.presets[].members | array<object> | Yes | — |
| $.templates[].chart_presets.presets[].members[] | object | Yes | — |
| $.templates[].chart_presets.presets[].members[].axis | string; {"enum":["left","right"]} | Yes | — |
| $.templates[].chart_presets.presets[].members[].key | string | Yes | — |
| $.templates[].chart_presets.presets[].members[].mode | string; {"enum":["value","rate","increase"]} | Yes | — |
| $.templates[].chart_presets.presets[].members[].role | string; {"enum":["plot","limit","context"]} | Yes | — |
| $.templates[].chart_presets.presets[].members[].transform | string; {"enum":["busy_percent","pressure_percent","operations_mean"]} | No | — |
| $.templates[].chart_presets.presets[].members[].label_key | string | No | — |
| $.templates[].chart_presets.presets[].members[].optional | boolean | No | — |
| $.templates[].chart_presets.presets[].members[].denominator | string | No | — |
| $.templates[].chart_presets.presets[].presentation | string; {"enum":["line","area","bar","capacity","stack","state","duration"]} | Yes | — |
| $.templates[].chart_presets.presets[].stack_keys | array<string> | No | — |
| $.templates[].chart_presets.presets[].stack_keys[] | string | Yes | — |
| $.templates[].chart_presets.presets[].title_key | string | Yes | — |
| $.templates[].chart_presets.presets[].setup_preset | string; {"enum":["server-overview","server-overview-optional"]} | No | — |
| $.templates[].chart_presets.presets[].display_unit | string; {"enum":["auto","bits"]} | No | — |
| $.templates[].chart_presets.version | integer; {"minimum":1} | Yes | — |
| $.server_platform_capabilities | object | No | — |
| $.server_platform_capabilities.linux | array<string> | Yes | — |
| $.server_platform_capabilities.linux[] | string | Yes | — |
| $.server_platform_capabilities.darwin | array<string> | Yes | — |
| $.server_platform_capabilities.darwin[] | string | Yes | — |
| $.server_platform_capabilities.windows | array<string> | Yes | — |
| $.server_platform_capabilities.windows[] | string | Yes | — |
| $.server_platform_minimum_intervals | object; {"additionalProperties":false} | No | — |
| $.server_platform_minimum_intervals.linux | object | Yes | — |
| $.server_platform_minimum_intervals.darwin | object | Yes | — |
| $.server_platform_minimum_intervals.windows | object | Yes | — |
{
"alarm_suggestions_active_by_default": false,
"apply_available": false,
"templates": []
}| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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": 401,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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": 403,
"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.
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/templates"
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/templates", 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()
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/templates", {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
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/templates", nil)
if err != nil { panic("request failed; credentials and response omitted") }
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; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Apply a template atomically in your workspace
Atomically applies a template within account limits. Server/NAS v2 reserves the monitor, series and selected alarm slots and returns a resumable job; other templates are applied immediately. Repeated normalized requests replay the existing monitor.
- POST Check template capacity without reserving it
Preview the resources and capacity needed by a template without creating them. A preview does not reserve slots; apply checks the available capacity again.
- POST Validate a template without changing resources
Validates syntax, version, configuration and alarm choices without reserving resources. Ownership and capacity checks belong to plan and apply.