MetriBeacon
Menu

PUT Save a private maintenance schedule

/api/v1/maintenance-schedules/{id}

Private one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.

On this page

Access and permissions

Private one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.

Browser session: __Host-mb_session cookie.

Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.

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

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource ID in this workspace
Idempotency-KeyHeaderstring; {"maxLength":128,"minLength":16,"pattern":"^[A-Za-z0-9._~-]{16,128}$"}NoPrivate one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.

Request body

FieldType and limitsRequiredMeaning
$objectYes—
$.configobjectYesPrivate one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.
$.config.device_idsarray<string; {"format":"uuid"}>; {"maxItems":100}Yes—
$.config.device_ids[]string; {"format":"uuid"}Yes—
$.config.duration_secondsinteger; {"maximum":604800,"minimum":60}No—
$.config.ends_atstring; {"format":"date-time"}No—
$.config.group_idsarray<string; {"format":"uuid"}>; {"maxItems":100}Yes—
$.config.group_ids[]string; {"format":"uuid"}Yes—
$.config.kindstring; {"enum":["once","weekly"]}Yes—
$.config.local_timestring; {"pattern":"^[0-2][0-9]:[0-5][0-9]$"}No—
$.config.starts_atstring; {"format":"date-time"}No—
$.config.targetstring; {"enum":["workspace","groups","monitors"]}Yes—
$.config.timezonestring; {"maxLength":64,"minLength":1}Yes—
$.config.weekdayinteger; {"maximum":7,"minimum":1}No—
$.enabledbooleanYes—
$.expected_revisioninteger; {"minimum":1}Yes—
$.namestring; {"maxLength":128,"minLength":1}Yes—

Responses

application/json

FieldType and limitsRequiredMeaning
$objectYes—
$.configobjectYesPrivate one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.
$.config.device_idsarray<string; {"format":"uuid"}>; {"maxItems":100}Yes—
$.config.device_ids[]string; {"format":"uuid"}Yes—
$.config.duration_secondsinteger; {"maximum":604800,"minimum":60}No—
$.config.ends_atstring; {"format":"date-time"}No—
$.config.group_idsarray<string; {"format":"uuid"}>; {"maxItems":100}Yes—
$.config.group_ids[]string; {"format":"uuid"}Yes—
$.config.kindstring; {"enum":["once","weekly"]}Yes—
$.config.local_timestring; {"pattern":"^[0-2][0-9]:[0-5][0-9]$"}No—
$.config.starts_atstring; {"format":"date-time"}No—
$.config.targetstring; {"enum":["workspace","groups","monitors"]}Yes—
$.config.timezonestring; {"maxLength":64,"minLength":1}Yes—
$.config.weekdayinteger; {"maximum":7,"minimum":1}No—
$.enabledbooleanYes—
$.idstring; {"format":"uuid"}Yes—
$.namestring; {"maxLength":128,"minLength":1}Yes—
$.occurrencesarray<object>Yes—
$.occurrences[]objectYes—
$.occurrences[].ends_atstring; {"format":"date-time"}Yes—
$.occurrences[].starts_atstring; {"format":"date-time"}Yes—
$.revisioninteger; {"minimum":1}Yes—
$.updated_atstring; {"format":"date-time"}Yes—
$.workspace_idstring; {"format":"uuid"}Yes—
json
{
  "config": {
    "device_ids": [],
    "duration_seconds": 3600,
    "group_ids": [],
    "kind": "weekly",
    "local_time": "08:00",
    "target": "workspace",
    "timezone": "Europe/Berlin",
    "weekday": 1
  },
  "enabled": true,
  "id": "00000000-0000-4000-8000-000000000001",
  "name": "Maintenance demo",
  "occurrences": [],
  "revision": 1,
  "updated_at": "2026-10-02T08:00:00Z",
  "workspace_id": "00000000-0000-4000-8000-000000000001"
}
Stable error codes
unauthorized
invalid_credential

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
forbidden
csrf
insufficient_scope
workspace_scope

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
not_found

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
idempotency_conflict
revision_conflict

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
invalid_dashboard
invalid_dashboard_sources
invalid_idempotency_key
invalid_maintenance
invalid_maintenance_targets
invalid_reference
invalid_workspace

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
dashboard_limit
maintenance_limit

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
unavailable

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—

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.

shell
curl --fail-with-body --request PUT --header @"$HOME/.config/metribeacon/headers.txt" --header 'Content-Type: application/json' --header 'Idempotency-Key: maintenance-example-key' --data-binary '{"name":"Maintenance demo","enabled":true,"config":{"kind":"weekly","weekday":1,"local_time":"08:00","timezone":"Europe/Berlin","duration_seconds":3600,"target":"workspace","device_ids":[],"group_ids":[]},"expected_revision":1}' "https://metribeacon.com/api/v1/maintenance-schedules/00000000-0000-4000-8000-000000000001"
python
import json, os, urllib.request
request = urllib.request.Request('https://metribeacon.com/api/v1/maintenance-schedules/00000000-0000-4000-8000-000000000001', method='PUT', headers={"Cookie": os.environ["MB_COOKIE"], "X-CSRF-Token": os.environ["MB_CSRF"], "Content-Type": "application/json", "Idempotency-Key": "maintenance-example-key"}, data=json.dumps({'name': 'Maintenance demo', 'enabled': True, 'config': {'kind': 'weekly', 'weekday': 1, 'local_time': '08:00', 'timezone': 'Europe/Berlin', 'duration_seconds': 3600, 'target': 'workspace', 'device_ids': [], 'group_ids': []}, 'expected_revision': 1}).encode())
with urllib.request.urlopen(request, timeout=30) as response:
    print(json.load(response))
javascript
const response = await fetch("https://metribeacon.com/api/v1/maintenance-schedules/00000000-0000-4000-8000-000000000001", {method: "PUT", headers: {"Cookie": process.env.MB_COOKIE, "X-CSRF-Token": process.env.MB_CSRF, "Content-Type": "application/json", "Idempotency-Key": "maintenance-example-key"}, body: JSON.stringify({"name": "Maintenance demo", "enabled": true, "config": {"kind": "weekly", "weekday": 1, "local_time": "08:00", "timezone": "Europe/Berlin", "duration_seconds": 3600, "target": "workspace", "device_ids": [], "group_ids": []}, "expected_revision": 1}), signal: AbortSignal.timeout(30000)});
console.log(await response.json());
go
package main
import ("fmt"; "net/http"; "os"; "io"; "strings"; "time")
func main() {
 req, err := http.NewRequest("PUT", "https://metribeacon.com/api/v1/maintenance-schedules/00000000-0000-4000-8000-000000000001", strings.NewReader("{\"name\":\"Maintenance demo\",\"enabled\":true,\"config\":{\"kind\":\"weekly\",\"weekday\":1,\"local_time\":\"08:00\",\"timezone\":\"Europe/Berlin\",\"duration_seconds\":3600,\"target\":\"workspace\",\"device_ids\":[],\"group_ids\":[]},\"expected_revision\":1}")); if err != nil { panic(err) }; req.Header.Set("Cookie", os.Getenv("MB_COOKIE")); req.Header.Set("X-CSRF-Token", os.Getenv("MB_CSRF")); req.Header.Set("Content-Type", "application/json"); req.Header.Set("Idempotency-Key", "maintenance-example-key"); client := &http.Client{Timeout:30*time.Second}; response, err := client.Do(req); if err != nil { panic(err) }; defer response.Body.Close(); _, _ = io.Copy(os.Stdout, response.Body); fmt.Println()
}
  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • DELETE Remove a private maintenance schedule

    Private one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.

  • GET List workspace maintenance

    Private one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.

  • POST Create a private maintenance schedule

    Private one-time or weekly maintenance. Telemetry and alarm states continue; deliveries are suppressed. IANA gaps are skipped and repeated times use their first occurrence. Disabled schedules consume one of 20 slots. Edits preserve past coverage; group changes take effect going forward. Public notices require a separate draft and status page publication permission.