200 · Successful response. 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; {"additionalProperties":false} Yes — $.workspace_id string; {"format":"uuid"} Yes — $.revision integer Yes — $.cards array<object; {"additionalProperties":false}>; {"maxItems":30} Yes — $.cards[] object; {"additionalProperties":false} Yes — $.cards[].id string; {"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,79}$"} Yes — $.cards[].type string; {"enum":["monitoring","monitor_health","incidents","performance","servers","status_pages","usage","activity","slos","next_steps","monitors","metric","chart","maintenance","server_resources"]} Yes — $.cards[].visible boolean Yes — $.cards[].width integer; {"minimum":1,"maximum":3} Yes — $.cards[].title string; {"maxLength":120} No — $.cards[].settings object; {"additionalProperties":false} Yes — $.cards[].settings.mode string; {"enum":["auto","fixed"]} No — $.cards[].settings.resource_ids array<string; {"format":"uuid"}>; {"maxItems":20} No — $.cards[].settings.resource_ids[] string; {"format":"uuid"} Yes — $.cards[].settings.limit integer; {"enum":[3,5,10,20]} No — $.cards[].settings.severities array<string; {"enum":["info","warning","critical"]}> No — $.cards[].settings.severities[] string; {"enum":["info","warning","critical"]} Yes — $.cards[].settings.series array<object; {"additionalProperties":false}>; {"maxItems":8} No — $.cards[].settings.series[] object; {"additionalProperties":false} Yes — $.cards[].settings.series[].id string; {"format":"uuid"} Yes — $.cards[].settings.series[].axis string; {"enum":["left","right"]} Yes — $.cards[].settings.range string; {"enum":["24h","7d","30d"]} No — $.cards[].settings.height string; {"enum":["small","medium","large"]} No —
json Copy example
{
"workspace_id" : "00000000-0000-4000-8000-000000000001" ,
"revision" : 1,
"cards" : [
{
"id" : "monitoring" ,
"visible" : true ,
"type" : "monitoring" ,
"width" : 1,
"settings" : {}
},
{
"id" : "incidents" ,
"visible" : true ,
"type" : "incidents" ,
"width" : 1,
"settings" : {}
},
{
"id" : "performance" ,
"visible" : true ,
"type" : "performance" ,
"width" : 1,
"settings" : {}
},
{
"id" : "servers" ,
"visible" : true ,
"type" : "servers" ,
"width" : 1,
"settings" : {}
},
{
"id" : "status_pages" ,
"visible" : true ,
"type" : "status_pages" ,
"width" : 1,
"settings" : {}
},
{
"id" : "usage" ,
"visible" : true ,
"type" : "usage" ,
"width" : 1,
"settings" : {}
},
{
"id" : "activity" ,
"visible" : true ,
"type" : "activity" ,
"width" : 1,
"settings" : {}
},
{
"id" : "slos" ,
"visible" : true ,
"type" : "slos" ,
"width" : 1,
"settings" : {}
},
{
"id" : "next_steps" ,
"visible" : true ,
"type" : "next_steps" ,
"width" : 1,
"settings" : {}
}
]
} 401 · Request rejected. Inspect the stable problem code. 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 —
json Copy example
{
"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"
} 403 · Request rejected. Inspect the stable problem code. Stable error codes csrf forbidden 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 —
json Copy example
{
"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"
} 422 · Request rejected. Inspect the stable problem code. Stable error codes invalid_dashboard
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 —
json Copy example
{
"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"
} 503 · Request rejected. Inspect the stable problem code. Stable error codes unavailable
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. Retry-After string; {"pattern":"^[0-9]+$"} Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. 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 —
json Copy example
{
"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" : 503,
"title" : "Demo error" ,
"type" : "about:blank"
} 409 · Invalid dashboard configuration Stable error codes revision_conflict
404 · Workspace not found Stable error codes not_found unavailable
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. Retry-After string; {"pattern":"^[0-9]+$"} Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. 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 —
json Copy example
{
"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" : 503,
"title" : "Demo error" ,
"type" : "about:blank"
} 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 Copy example
curl --silent --show-error --output /dev/ null --write-out "%{http_code}\n" \
--request PUT \
--header @ "$HOME/.config/metribeacon/headers.txt" \
--header "Content-Type: application/json" \
--data-binary '{"cards":[{"id":"monitoring","type":"monitoring","visible":true,"width":1,"settings":{}},{"id":"incidents","type":"incidents","visible":true,"width":1,"settings":{}},{"id":"performance","type":"performance","visible":true,"width":1,"settings":{}},{"id":"servers","type":"servers","visible":true,"width":1,"settings":{}},{"id":"status_pages","type":"status_pages","visible":true,"width":1,"settings":{}},{"id":"usage","type":"usage","visible":true,"width":1,"settings":{}},{"id":"activity","type":"activity","visible":true,"width":1,"settings":{}},{"id":"slos","type":"slos","visible":true,"width":1,"settings":{}},{"id":"next_steps","type":"next_steps","visible":true,"width":1,"settings":{}}],"expected_revision":0}' \
"https://metribeacon.com/api/v1/dashboard/config?workspace_id=00000000-0000-4000-8000-000000000001"
python Copy example
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())
headers[ "Content-Type" ] = "application/json"
request = Request( "https://metribeacon.com/api/v1/dashboard/config?workspace_id=00000000-0000-4000-8000-000000000001" , data= "{\"cards\":[{\"id\":\"monitoring\",\"type\":\"monitoring\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"incidents\",\"type\":\"incidents\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"performance\",\"type\":\"performance\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"servers\",\"type\":\"servers\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"status_pages\",\"type\":\"status_pages\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"usage\",\"type\":\"usage\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"activity\",\"type\":\"activity\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"slos\",\"type\":\"slos\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"next_steps\",\"type\":\"next_steps\",\"visible\":true,\"width\":1,\"settings\":{}}],\"expected_revision\":0}" .encode( "utf-8" ), headers=headers, method= "PUT" )
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 Copy example
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/dashboard/config?workspace_id=00000000-0000-4000-8000-000000000001" , {
method: "PUT" , headers, redirect: "manual" ,
signal: AbortSignal.timeout(10000), body: "{\"cards\":[{\"id\":\"monitoring\",\"type\":\"monitoring\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"incidents\",\"type\":\"incidents\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"performance\",\"type\":\"performance\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"servers\",\"type\":\"servers\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"status_pages\",\"type\":\"status_pages\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"usage\",\"type\":\"usage\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"activity\",\"type\":\"activity\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"slos\",\"type\":\"slos\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"next_steps\",\"type\":\"next_steps\",\"visible\":true,\"width\":1,\"settings\":{}}],\"expected_revision\":0}" ,
});
console.log(response.status);
await response.body?.cancel();
go Copy example
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
"strings"
)
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( "PUT" , "https://metribeacon.com/api/v1/dashboard/config?workspace_id=00000000-0000-4000-8000-000000000001" , strings.NewReader( "{\"cards\":[{\"id\":\"monitoring\",\"type\":\"monitoring\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"incidents\",\"type\":\"incidents\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"performance\",\"type\":\"performance\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"servers\",\"type\":\"servers\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"status_pages\",\"type\":\"status_pages\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"usage\",\"type\":\"usage\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"activity\",\"type\":\"activity\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"slos\",\"type\":\"slos\",\"visible\":true,\"width\":1,\"settings\":{}},{\"id\":\"next_steps\",\"type\":\"next_steps\",\"visible\":true,\"width\":1,\"settings\":{}}],\"expected_revision\":0}" ))
if err != nil { panic( "request failed; credentials and response omitted" ) }
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; credentials and response omitted" ) }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}