PUT Update a personal report selection
/api/v1/account/reporting-presets/{id}
Browser-session-only preferences for an accessible workspace. Up to 50 named selections per person and workspace, including viewers. Saves definitions, filters and period, never results or computation jobs. Writes require CSRF. Reuse the client-generated ID and identical create payload after a lost response. Updates and deletion require the current expected_revision; stale changes return 409. Source permissions and result expiry remain unchanged.
On this page
Access and permissions
Browser-session-only preferences for an accessible workspace. Up to 50 named selections per person and workspace, including viewers. Saves definitions, filters and period, never results or computation jobs. Writes require CSRF. Reuse the client-generated ID and identical create payload after a lost response. Updates and deletion require the current expected_revision; stale changes return 409. Source permissions and result expiry remain unchanged.
Browser session: __Host-mb_session cookie.
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.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| X-CSRF-Token | Header | string | Yes | 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. |
| workspace_id | URL query | string; {"format":"uuid"} | Yes | Limit the list to an accessible workspace. |
| id | Path | string; {"format":"uuid"} | Yes | Resource ID in this workspace |
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Yes | — |
| $.name | string; {"minLength":1,"maxLength":128} | Yes | — |
| $.definition | ReportingDefinition | Yes | — |
| $.definition.adjusted | boolean | No | — |
| $.definition.chart_sources | array<string; {"maxLength":200}>; {"maxItems":8} | No | — |
| $.definition.chart_sources[] | string; {"maxLength":200} | Yes | — |
| $.definition.filters | ReportingFilters | Yes | — |
| $.definition.filters.channel | string; {"enum":["","email","telegram","discord","slack","ntfy","webhook","webpush"]} | No | — |
| $.definition.filters.filesystem | string; {"maxLength":512} | No | — |
| $.definition.filters.group_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.definition.filters.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.definition.filters.location_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.definition.filters.location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.definition.filters.monitor_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.definition.filters.monitor_ids[] | string; {"format":"uuid"} | Yes | — |
| $.definition.filters.resource | string; {"enum":["","cpu","memory","filesystem","disk","network"]} | No | — |
| $.definition.filters.severity | string; {"enum":["","info","warning","critical"]} | No | — |
| $.definition.filters.types | array<string; {"maxLength":32}>; {"maxItems":1000} | No | — |
| $.definition.filters.types[] | string; {"maxLength":32} | Yes | — |
| $.definition.granularity | string; {"enum":["hour","day","week","month"]} | Yes | — |
| $.definition.language | string; {"enum":["en","de"]} | No | — |
| $.definition.sections | array<string; {"enum":["overview","availability","incidents","mttr","mtta","response","maintenance","notifications","certificates","jobs","resources"]}>; {"maxItems":11,"minItems":1} | Yes | — |
| $.definition.sections[] | string; {"enum":["overview","availability","incidents","mttr","mtta","response","maintenance","notifications","certificates","jobs","resources"]} | Yes | — |
| $.definition.timezone | string; {"maxLength":64} | Yes | — |
| $.definition.version | integer; {"const":1} | No | — |
| $.period | ReportingPresetPeriod | Yes | Relative periods are recalculated when opened. Use days=1 for exactly 24 hours, including daylight-saving transitions, or 7, 30 or 90 for calendar days. Fixed periods keep from/to. Existing period and hourly grouping limits apply. |
| $.period.kind | string; {"enum":["relative","fixed"]} | Yes | — |
| $.period.days | integer; {"enum":[1,7,30,90]} | No | — |
| $.period.from | string; {"format":"date-time"} | No | — |
| $.period.to | string; {"format":"date-time"} | No | — |
| $.id | string; {"format":"uuid"} | No | — |
| $.expected_revision | integer; {"minimum":1} | Yes | — |
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 |
|---|---|---|---|
| $ | ReportingPreset | Yes | — |
| $.id | string; {"format":"uuid"} | Yes | — |
| $.revision | integer; {"minimum":1} | Yes | — |
| $.updated_at | string; {"format":"date-time"} | Yes | — |
| $.name | string; {"minLength":1,"maxLength":128} | Yes | — |
| $.definition | ReportingDefinition | Yes | — |
| $.definition.adjusted | boolean | No | — |
| $.definition.chart_sources | array<string; {"maxLength":200}>; {"maxItems":8} | No | — |
| $.definition.chart_sources[] | string; {"maxLength":200} | Yes | — |
| $.definition.filters | ReportingFilters | Yes | — |
| $.definition.filters.channel | string; {"enum":["","email","telegram","discord","slack","ntfy","webhook","webpush"]} | No | — |
| $.definition.filters.filesystem | string; {"maxLength":512} | No | — |
| $.definition.filters.group_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.definition.filters.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.definition.filters.location_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.definition.filters.location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.definition.filters.monitor_ids | array<string; {"format":"uuid"}>; {"maxItems":1000} | No | — |
| $.definition.filters.monitor_ids[] | string; {"format":"uuid"} | Yes | — |
| $.definition.filters.resource | string; {"enum":["","cpu","memory","filesystem","disk","network"]} | No | — |
| $.definition.filters.severity | string; {"enum":["","info","warning","critical"]} | No | — |
| $.definition.filters.types | array<string; {"maxLength":32}>; {"maxItems":1000} | No | — |
| $.definition.filters.types[] | string; {"maxLength":32} | Yes | — |
| $.definition.granularity | string; {"enum":["hour","day","week","month"]} | Yes | — |
| $.definition.language | string; {"enum":["en","de"]} | No | — |
| $.definition.sections | array<string; {"enum":["overview","availability","incidents","mttr","mtta","response","maintenance","notifications","certificates","jobs","resources"]}>; {"maxItems":11,"minItems":1} | Yes | — |
| $.definition.sections[] | string; {"enum":["overview","availability","incidents","mttr","mtta","response","maintenance","notifications","certificates","jobs","resources"]} | Yes | — |
| $.definition.timezone | string; {"maxLength":64} | Yes | — |
| $.definition.version | integer; {"const":1} | No | — |
| $.period | ReportingPresetPeriod | Yes | Relative periods are recalculated when opened. Use days=1 for exactly 24 hours, including daylight-saving transitions, or 7, 30 or 90 for calendar days. Fixed periods keep from/to. Existing period and hourly grouping limits apply. |
| $.period.kind | string; {"enum":["relative","fixed"]} | Yes | — |
| $.period.days | integer; {"enum":[1,7,30,90]} | No | — |
| $.period.from | string; {"format":"date-time"} | No | — |
| $.period.to | string; {"format":"date-time"} | No | — |
| Stable error codes |
|---|
| invalid_language |
| invalid_preferences |
| invalid_timezone |
| 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": 400,
"title": "Demo error",
"type": "about:blank"
}| 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 |
|---|
| browser_session_required |
| 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"
}| 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 | — |
{
"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"
}| 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 | — |
{
"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": 400,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| preset_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 | — |
{
"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": 400,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| invalid_preset |
| invalid_preset_sources |
| 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": 400,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| preset_limit |
| 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": 400,
"title": "Demo error",
"type": "about:blank"
}Retries and asynchronous work
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.
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 --request PUT --header @"$HOME/.config/metribeacon/headers.txt" --header "Content-Type: application/json" --data-binary '{"id":"00000000-0000-4000-8000-000000000001","name":"Weekly overview","definition":{"version":1,"language":"en","timezone":"Europe/Berlin","sections":["availability"],"granularity":"day","filters":{"monitor_ids":[],"types":[],"group_ids":[],"location_ids":[]}},"period":{"kind":"relative","days":7},"expected_revision":1}' 'https://metribeacon.com/api/v1/account/reporting-presets/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001'
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
headers=json.loads((Path.home()/".config/metribeacon/headers.json").read_text())
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target): return None
headers["Content-Type"]="application/json"
request=Request('https://metribeacon.com/api/v1/account/reporting-presets/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001', data=json.dumps({'id': '00000000-0000-4000-8000-000000000001', 'name': 'Weekly overview', 'definition': {'version': 1, 'language': 'en', 'timezone': 'Europe/Berlin', 'sections': ['availability'], 'granularity': 'day', 'filters': {'monitor_ids': [], 'types': [], 'group_ids': [], 'location_ids': []}}, 'period': {'kind': 'relative', 'days': 7}, 'expected_revision': 1}).encode(), headers=headers, method='PUT')
with build_opener(NoRedirect).open(request, timeout=10) as response:
print(response.status)
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/account/reporting-presets/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001",{method:"PUT",headers,redirect:"error",signal:AbortSignal.timeout(10000),body:JSON.stringify({"id":"00000000-0000-4000-8000-000000000001","name":"Weekly overview","definition":{"version":1,"language":"en","timezone":"Europe/Berlin","sections":["availability"],"granularity":"day","filters":{"monitor_ids":[],"types":[],"group_ids":[],"location_ids":[]}},"period":{"kind":"relative","days":7},"expected_revision":1})});
console.log(response.status); await response.body?.cancel();
package main
import("encoding/json";"fmt";"net/http";"os";"path/filepath";"time";"strings")
func main(){home,e:=os.UserHomeDir();if e!=nil{return};raw,e:=os.ReadFile(filepath.Join(home,".config/metribeacon/headers.json"));if e!=nil{return};var headers map[string]string;if json.Unmarshal(raw,&headers)!=nil{return};req,e:=http.NewRequest("PUT","https://metribeacon.com/api/v1/account/reporting-presets/00000000-0000-4000-8000-000000000001?workspace_id=00000000-0000-4000-8000-000000000001",strings.NewReader("{\"id\":\"00000000-0000-4000-8000-000000000001\",\"name\":\"Weekly overview\",\"definition\":{\"version\":1,\"language\":\"en\",\"timezone\":\"Europe/Berlin\",\"sections\":[\"availability\"],\"granularity\":\"day\",\"filters\":{\"monitor_ids\":[],\"types\":[],\"group_ids\":[],\"location_ids\":[]}},\"period\":{\"kind\":\"relative\",\"days\":7},\"expected_revision\":1}"));if e!=nil{return};for k,v:=range headers{req.Header.Set(k,v)};req.Header.Set("Content-Type","application/json");client:=&http.Client{Timeout:10*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}};res,e:=client.Do(req);if e!=nil{return};defer res.Body.Close();fmt.Println(res.StatusCode)}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- DELETE Delete a personal report selection
Browser-session-only preferences for an accessible workspace. Up to 50 named selections per person and workspace, including viewers. Saves definitions, filters and period, never results or computation jobs. Writes require CSRF. Reuse the client-generated ID and identical create payload after a lost response. Updates and deletion require the current expected_revision; stale changes return 409. Source permissions and result expiry remain unchanged.
- GET List personal report selections
Browser-session-only preferences for an accessible workspace. Up to 50 named selections per person and workspace, including viewers. Saves definitions, filters and period, never results or computation jobs. Writes require CSRF. Reuse the client-generated ID and identical create payload after a lost response. Updates and deletion require the current expected_revision; stale changes return 409. Source permissions and result expiry remain unchanged.
- POST Save a personal report selection
Browser-session-only preferences for an accessible workspace. Up to 50 named selections per person and workspace, including viewers. Saves definitions, filters and period, never results or computation jobs. Writes require CSRF. Reuse the client-generated ID and identical create payload after a lost response. Updates and deletion require the current expected_revision; stale changes return 409. Source permissions and result expiry remain unchanged.