GET Read automatic server setup progress
/api/v1/agent/install-codes/{id}
Reports receipt of the first heartbeat and selected measurements after enrollment. The issuing browser can read this status after the code expires.
On this page
Access and permissions
Reports receipt of the first heartbeat and selected measurements after enrollment. The issuing browser can read this status after the code expires.
Browser session: __Host-mb_session cookie.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | Installation setting or machine-reported value. |
| workspace_id | URL query | string; {"format":"uuid"} | No | Installation setting or machine-reported value. |
Request body
No request body.
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | AgentInstallStatus | Yes | — |
| $.id | string; {"format":"uuid"} | Yes | Installation setting or machine-reported value. |
| $.status | string; {"enum":["waiting","connected","ready","expired","revoked"]} | Yes | Installation setting or machine-reported value. |
| $.expires_at | string; {"format":"date-time"} | Yes | Installation setting or machine-reported value. |
| $.device_id | string | null; {"format":"uuid"} | Yes | Installation setting or machine-reported value. |
| $.heartbeat_accepted | boolean | Yes | Installation setting or machine-reported value. |
| $.measurement_accepted | boolean | Yes | Installation setting or machine-reported value. |
| $.settings | object | No | — |
| $.settings.name | string | No | — |
| $.settings.platform | string; {"enum":["unix","windows"]} | No | — |
| $.settings.interval_seconds | integer | No | — |
| $.settings.group_ids | array | null | No | — |
| $.settings.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.settings.server_profile | AgentProfile | No | — |
| $.settings.server_profile.components | array<AgentComponent>; {"maxItems":200} | Yes | — |
| $.settings.server_profile.components[] | AgentComponent | Yes | — |
| $.settings.server_profile.components[].address | string | No | — |
| $.settings.server_profile.components[].family | string | No | — |
| $.settings.server_profile.components[].id | string | Yes | — |
| $.settings.server_profile.components[].kind | string; {"enum":["system","filesystem","disk","network","process","container","file","program","connection","ping","storage_pool"]} | Yes | — |
| $.settings.server_profile.components[].label | string | Yes | — |
| $.settings.server_profile.components[].local_ref | string | No | — |
| $.settings.server_profile.components[].name | string | No | — |
| $.settings.server_profile.components[].path | string | No | — |
| $.settings.server_profile.components[].port | integer; {"maximum":65535,"minimum":0} | No | — |
| $.settings.server_profile.components[].project | string | No | — |
| $.settings.server_profile.components[].protocol | string | No | — |
| $.settings.server_profile.components[].text_languages | object | No | — |
| $.settings.server_profile.components[].timeout_seconds | integer; {"minimum":0} | No | — |
| $.settings.server_profile.components[].translations | object; {"additionalProperties":false} | No | — |
| $.settings.server_profile.components[].translations.de | object | No | — |
| $.settings.server_profile.components[].translations.en | object | No | — |
| $.settings.server_profile.components[].transport | string | No | — |
| $.settings.server_profile.components[].filesystem_identity | string; {"maxLength":256} | No | Agent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history. |
| $.settings.server_profile.components[].disk_identity | string; {"maxLength":256} | No | — |
| $.settings.server_profile.selections | array<AgentSelection>; {"maxItems":200} | Yes | — |
| $.settings.server_profile.selections[] | AgentSelection | Yes | — |
| $.settings.server_profile.selections[].component_id | string | Yes | — |
| $.settings.server_profile.selections[].interval_seconds | integer; {"maximum":86400,"minimum":1} | Yes | — |
| $.settings.server_profile.selections[].parameter_key | string | Yes | — |
| $.settings.server_profile.version | integer; {"const":2} | Yes | — |
| $.settings.server_profile.overview | object; {"additionalProperties":false} | No | Explicit targets for the six-chart server overview; select all required readings. |
| $.settings.server_profile.overview.system_id | string; {"maxLength":128} | Yes | — |
| $.settings.server_profile.overview.filesystem_id | string; {"maxLength":128} | Yes | — |
| $.settings.server_profile.overview.disk_id | string; {"maxLength":128} | Yes | — |
| $.settings.server_profile.overview.network_id | string; {"maxLength":128} | Yes | — |
| $.settings.server_profile.filesystem_discovery | object; {"additionalProperties":false} | No | Optional local filesystem discovery with a base interval of at least 10 seconds. New Server/NAS setups enable it. Existing profiles require explicit activation. Manually disabled measurements are preserved. |
| $.settings.server_profile.filesystem_discovery.mode | string; {"enum":["off","local"]} | Yes | — |
| $.settings.server_profile.filesystem_discovery.interval_seconds | integer; {"minimum":10,"maximum":86400} | Yes | — |
| $.settings.server_profile.system_discovery | object; {"additionalProperties":false} | No | — |
| $.settings.server_profile.system_discovery.mode | string; {"enum":["off","local"]} | Yes | — |
| $.settings.server_profile.system_discovery.interval_seconds | integer; {"minimum":10,"maximum":86400} | Yes | — |
| $.settings.server_profile.global_interval_seconds | integer; {"minimum":1,"maximum":86400} | No | Explicit global sampling choice. Each source still applies its platform minimum; individual fast rows never imply this choice. |
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 | — |
| 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 | — |
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 | — |
| 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 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 --fail-with-body --request GET 'https://metribeacon.com/api/v1/agent/install-codes/33333333-3333-4333-8333-333333333333' --header 'Accept: application/json' --header 'Cookie: __Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF'import urllib.request
headers = {'Accept': 'application/json', 'Cookie': '__Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF'}
request = urllib.request.Request('https://metribeacon.com/api/v1/agent/install-codes/33333333-3333-4333-8333-333333333333', headers=headers, method='GET')
with urllib.request.urlopen(request) as response:
print(response.read().decode())
const response = await fetch("https://metribeacon.com/api/v1/agent/install-codes/33333333-3333-4333-8333-333333333333", {"method": "GET", "headers": {"Accept": "application/json", "Cookie": "__Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF"}});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.text());
package main
import ("fmt"; "io"; "net/http"; "strings")
func main() {
req, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/agent/install-codes/33333333-3333-4333-8333-333333333333", strings.NewReader("")); if err != nil { panic(err) }
req.Header.Set("Accept","application/json")
req.Header.Set("Cookie","__Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF")
response, err := http.DefaultClient.Do(req); if err != nil { panic(err) }; defer response.Body.Close(); data, err := io.ReadAll(response.Body); if err != nil { panic(err) }; fmt.Printf("HTTP %d\n%s\n", response.StatusCode, data)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- DELETE Revoke an unused installation code
Revokes an unused code. Already enrolled servers and their device keys remain managed through the existing monitor and key interfaces.
- POST Create a single-use server installation code
Browser-authorized ten-minute code bound to this workspace and selected profile. Creates no monitor until redemption; requires editor rights. Only a code hash is stored.
- POST Enroll a server with an installation code
Atomically creates or connects the bound server, profile, groups and a device-scoped key from the locally generated key hash. Identical claims resume safely; a private device key can recover a committed claim after code expiry.