GET List workspace maintenance
/api/v1/workspaces/{id}/maintenance-schedules
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.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | Resource ID in this workspace |
Request body
No request body.
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | Yes | — |
| $.limit | integer; {"const":20} | Yes | — |
| $.schedules | array<object>; {"maxItems":20} | Yes | — |
| $.schedules[] | object | Yes | — |
| $.schedules[].config | object | Yes | 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. |
| $.schedules[].config.device_ids | array<string; {"format":"uuid"}>; {"maxItems":100} | Yes | — |
| $.schedules[].config.device_ids[] | string; {"format":"uuid"} | Yes | — |
| $.schedules[].config.duration_seconds | integer; {"maximum":604800,"minimum":60} | No | — |
| $.schedules[].config.ends_at | string; {"format":"date-time"} | No | — |
| $.schedules[].config.group_ids | array<string; {"format":"uuid"}>; {"maxItems":100} | Yes | — |
| $.schedules[].config.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.schedules[].config.kind | string; {"enum":["once","weekly"]} | Yes | — |
| $.schedules[].config.local_time | string; {"pattern":"^[0-2][0-9]:[0-5][0-9]$"} | No | — |
| $.schedules[].config.starts_at | string; {"format":"date-time"} | No | — |
| $.schedules[].config.target | string; {"enum":["workspace","groups","monitors"]} | Yes | — |
| $.schedules[].config.timezone | string; {"maxLength":64,"minLength":1} | Yes | — |
| $.schedules[].config.weekday | integer; {"maximum":7,"minimum":1} | No | — |
| $.schedules[].enabled | boolean | Yes | — |
| $.schedules[].id | string; {"format":"uuid"} | Yes | — |
| $.schedules[].name | string; {"maxLength":128,"minLength":1} | Yes | — |
| $.schedules[].occurrences | array<object> | Yes | — |
| $.schedules[].occurrences[] | object | Yes | — |
| $.schedules[].occurrences[].ends_at | string; {"format":"date-time"} | Yes | — |
| $.schedules[].occurrences[].starts_at | string; {"format":"date-time"} | Yes | — |
| $.schedules[].revision | integer; {"minimum":1} | Yes | — |
| $.schedules[].updated_at | string; {"format":"date-time"} | Yes | — |
| $.schedules[].workspace_id | string; {"format":"uuid"} | Yes | — |
{
"limit": 20,
"schedules": []
}| Stable error codes |
|---|
| unauthorized |
| invalid_credential |
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 | — |
| Stable error codes |
|---|
| forbidden |
| csrf |
| insufficient_scope |
| workspace_scope |
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 | — |
| Stable error codes |
|---|
| not_found |
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 | — |
| Stable error codes |
|---|
| idempotency_conflict |
| revision_conflict |
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 | — |
| Stable error codes |
|---|
| invalid_dashboard |
| invalid_dashboard_sources |
| invalid_idempotency_key |
| invalid_maintenance |
| invalid_maintenance_targets |
| invalid_reference |
| invalid_workspace |
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 | — |
| Stable error codes |
|---|
| dashboard_limit |
| maintenance_limit |
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 | — |
| Stable error codes |
|---|
| unavailable |
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 | — |
Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --fail-with-body --request GET --header @"$HOME/.config/metribeacon/headers.txt" "https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/maintenance-schedules"import json, os, urllib.request
request = urllib.request.Request("https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/maintenance-schedules", method="GET", headers={"Cookie": os.environ["MB_COOKIE"], "X-CSRF-Token": os.environ["MB_CSRF"], "Content-Type": "application/json"})
with urllib.request.urlopen(request, timeout=30) as response:
print(json.load(response))const response = await fetch("https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/maintenance-schedules", {method: "GET", headers: {"Cookie": process.env.MB_COOKIE, "X-CSRF-Token": process.env.MB_CSRF, "Content-Type": "application/json"}});
console.log(await response.json());package main
import ("fmt"; "net/http"; "os"; "io"; "strings")
func main() {
req, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/workspaces/00000000-0000-4000-8000-000000000001/maintenance-schedules", strings.NewReader("")); 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"); response, err := http.DefaultClient.Do(req); if err != nil { panic(err) }; defer response.Body.Close(); _, _ = io.Copy(os.Stdout, response.Body); fmt.Println()
}Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- 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.
- 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.
- PUT Save 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.