POST Review actions for selected monitors
/api/v1/monitors/bulk/plan
Select 1–100 monitors in one workspace and choose pause, resume, group assignment or collection interval. The preview lists the exact selection and account-wide daily consumption before and after the change. Reviewing changes nothing and reserves no capacity. Unsupported intervals or an increased allowance violation block the whole selection.
On this page
Access and permissions
Select 1–100 monitors in one workspace and choose pause, resume, group assignment or collection interval. The preview lists the exact selection and account-wide daily consumption before and after the change. Reviewing changes nothing and reserves no capacity. Unsupported intervals or an increased allowance violation block the whole selection.
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
No path, query or additional request-header parameters.
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | MonitorBulkRequest | Yes | — |
| $.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.device_ids | array<string; {"format":"uuid"}>; {"minItems":1,"maxItems":100} | Yes | — |
| $.device_ids[] | string; {"format":"uuid"} | Yes | — |
| $.operation_id | string; {"format":"uuid"} | Yes | A stable UUID for this operation. Keep it when retrying, including after a lost response. An Idempotency-Key may additionally bind the request; a reused key or operation with different data fails. |
| $.action | string; {"enum":["pause","resume","groups","interval"]} | Yes | — |
| $.interval_seconds | integer; {"minimum":1,"maximum":86400} | No | — |
| $.group_ids | array<string; {"format":"uuid"}>; {"maxItems":100} | No | — |
| $.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.group_mode | string; {"enum":["add","remove","replace"]} | No | — |
| $.version | string; {"pattern":"^[a-f0-9]{64}$"} | No | — |
| $.confirmed | boolean | No | — |
| $.actions_confirmed | boolean | No | — |
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | MonitorBulkPlan | Yes | — |
| $.version | string | Yes | — |
| $.allowed | boolean | Yes | — |
| $.requires_action_confirmation | boolean | Yes | — |
| $.before | object | Yes | — |
| $.before.items | number; {"minimum":0} | Yes | — |
| $.before.events | number; {"minimum":0} | Yes | — |
| $.before.bytes | number; {"minimum":0} | Yes | — |
| $.before.event_bytes | number; {"minimum":0} | Yes | — |
| $.after | object | Yes | — |
| $.after.items | number; {"minimum":0} | Yes | — |
| $.after.events | number; {"minimum":0} | Yes | — |
| $.after.bytes | number; {"minimum":0} | Yes | — |
| $.after.event_bytes | number; {"minimum":0} | Yes | — |
| $.limits | object | Yes | — |
| $.limits.items | number; {"minimum":0} | Yes | — |
| $.limits.events | number; {"minimum":0} | Yes | — |
| $.limits.bytes | number; {"minimum":0} | Yes | — |
| $.limits.event_bytes | number; {"minimum":0} | Yes | — |
| $.blocks | array<object> | Yes | — |
| $.blocks[] | object | Yes | — |
| $.blocks[].resource | string; {"enum":["items","events","bytes","event_bytes"]} | Yes | — |
| $.blocks[].planned | number | Yes | — |
| $.blocks[].limit | number | Yes | — |
| $.monitors | array<object>; {"maxItems":100} | Yes | — |
| $.monitors[] | object | Yes | — |
| $.monitors[].id | string; {"format":"uuid"} | Yes | — |
| $.monitors[].name | string | Yes | — |
| $.monitors[].type | string | Yes | — |
| $.monitors[].paused | boolean | Yes | — |
| $.monitors[].revision | integer | Yes | — |
| $.monitors[].collection_revision | integer | No | — |
| $.monitors[].profile_revision | integer | No | — |
| $.monitors[].group_ids | array<string; {"format":"uuid"}> | Yes | — |
| $.monitors[].group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.monitors[].mutating_check | boolean | Yes | — |
| $.monitors[].reason | string; {"enum":["unsupported","invalid_interval","agent_upgrade","quota"]} | No | — |
| Stable error codes |
|---|
| 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"
}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 | — |
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 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 --request POST --cookie '__Host-mb_session=SESSION; __Host-mb_csrf=CSRF' --header 'X-CSRF-Token: CSRF' --header 'Content-Type: application/json' --data '{"workspace_id":"11111111-1111-4111-8111-111111111111","device_ids":["22222222-2222-4222-8222-222222222222"],"operation_id":"33333333-3333-4333-8333-333333333333","action":"pause"}' 'https://metribeacon.com/api/v1/monitors/bulk/plan'import requests
response = requests.post('https://metribeacon.com/api/v1/monitors/bulk/plan', cookies={"__Host-mb_session":"SESSION","__Host-mb_csrf":"CSRF"}, headers={"X-CSRF-Token":"CSRF"}, json={'workspace_id': '11111111-1111-4111-8111-111111111111', 'device_ids': ['22222222-2222-4222-8222-222222222222'], 'operation_id': '33333333-3333-4333-8333-333333333333', 'action': 'pause'})
response.raise_for_status()const response = await fetch("https://metribeacon.com/api/v1/monitors/bulk/plan", {method:"POST", credentials:"same-origin", headers:{"Content-Type":"application/json","X-CSRF-Token":csrf}, body:JSON.stringify({"workspace_id":"11111111-1111-4111-8111-111111111111","device_ids":["22222222-2222-4222-8222-222222222222"],"operation_id":"33333333-3333-4333-8333-333333333333","action":"pause"})});
if (!response.ok) throw new Error(String(response.status));package main
import("net/http";"strings";"time")
func main() { req,err:=http.NewRequest("POST","https://metribeacon.com/api/v1/monitors/bulk/plan",strings.NewReader(`{"workspace_id":"11111111-1111-4111-8111-111111111111","device_ids":["22222222-2222-4222-8222-222222222222"],"operation_id":"33333333-3333-4333-8333-333333333333","action":"pause"}`));if err!=nil{panic("request failed")};req.AddCookie(&http.Cookie{Name:"__Host-mb_session",Value:"SESSION"});req.AddCookie(&http.Cookie{Name:"__Host-mb_csrf",Value:"CSRF"});req.Header.Set("X-CSRF-Token","CSRF");req.Header.Set("Content-Type","application/json");client:=http.Client{Timeout:10*time.Second};res,err:=client.Do(req);if err!=nil{panic("request failed")};defer res.Body.Close() }Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Apply reviewed actions to selected monitors
Send the same selection and operation UUID with the preview version and confirmed=true. Existing HTTP checks that can change targets additionally require actions_confirmed=true. A configuration, allowance or selection change requires a new preview. All selected monitors change together or none change; retries do not repeat the action. External client intervals and cron schedules use their individual settings.
- GET Read your monitors
Read your monitors.
- POST Create a monitor with its enabled type
Create a monitor with its enabled type.