Documentation / API · Device keys / Edit API key name and device access On this page Access and permissions Parameters and headers Request body Responses Retries and asynchronous work Request examples Related guides Changes take effect immediately without changing the secret. The workspace is immutable. Send the current revision from GET /keys; stale revisions return 409. All devices includes devices created later.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
Required machine permissions (scopes): keys:write When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.
Field Location Type and limits Required Meaning id Path string; {"format":"uuid"} Yes Resource UUID from the path. It must exist and be accessible to the acting identity. X-CSRF-Token Header string No Browser CSRF cookie value. Not required when an allowed machine management credential is used. Origin Header string; {"format":"uri"} No If present, must match the canonical HTTPS origin. Sec-Fetch-Site cross-site is rejected.
Field Type and limits Required Meaning $ KeyScopeRequest Yes — $.device_id string; {"format":"uuid"} No Target device UUID. Required for shared keys, implicit for one selected device. Header and body targets must match. $.device_ids array<string; {"format":"uuid"}>; {"maxItems":1000} No Distinct device UUIDs in this workspace. Empty for all-device access. $.device_ids[] string; {"format":"uuid"} Yes — $.device_scope string; {"default":"selected","enum":["selected","all"]} No selected allows device_ids; all includes current and future devices in this workspace. $.name string; {"maxLength":128} No Optional descriptive key name, up to 128 bytes. $.revision integer; {"minimum":1} No Current revision from GET /keys; required when editing. $.workspace_id string; {"format":"uuid"} No Workspace UUID. Access remains inside this workspace. $.agent_config_write boolean; {"default":false} No Explicitly allow local configuration writes, only for one selected Server monitor. Existing keys default to false. $.agent_remote_update boolean; {"default":false} No Independent remote-update permission for one server only. Defaults to false for general API keys and true for native installation keys. Omitted on PATCH preserves the current value. Key rotation preserves it.
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 Yes — $.id string; {"format":"uuid"} Yes — $.revision integer Yes —
json Copy example
{
"id" : "00000000-0000-4000-8000-000000000001" ,
"revision" : 2
} 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"
} 404 · Request rejected. Inspect the stable problem code. Stable error codes not_found
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"
} 409 · Request rejected. Inspect the stable problem code. Stable error codes version_conflict
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"
} 422 · Request rejected. Inspect the stable problem code. Stable error codes invalid_key_scope
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"
} This change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.
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 PATCH \
--header @ "$HOME/.config/metribeacon/headers.txt" \
--header "Content-Type: application/json" \
--data-binary '{"name":"Collector","workspace_id":"00000000-0000-4000-8000-000000000001","device_scope":"all","device_ids":[],"revision":1}' \
"https://metribeacon.com/api/v1/keys/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/keys/00000000-0000-4000-8000-000000000001" , data= "{\"name\":\"Collector\",\"workspace_id\":\"00000000-0000-4000-8000-000000000001\",\"device_scope\":\"all\",\"device_ids\":[],\"revision\":1}" .encode( "utf-8" ), headers=headers, method= "PATCH" )
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/keys/00000000-0000-4000-8000-000000000001" , {
method: "PATCH" , headers, redirect: "manual" ,
signal: AbortSignal.timeout(10000), body: "{\"name\":\"Collector\",\"workspace_id\":\"00000000-0000-4000-8000-000000000001\",\"device_scope\":\"all\",\"device_ids\":[],\"revision\":1}" ,
});
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( "PATCH" , "https://metribeacon.com/api/v1/keys/00000000-0000-4000-8000-000000000001" , strings.NewReader( "{\"name\":\"Collector\",\"workspace_id\":\"00000000-0000-4000-8000-000000000001\",\"device_scope\":\"all\",\"device_ids\":[],\"revision\":1}" ))
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)
}