MetriBeacon
Menu

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

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesInstallation setting or machine-reported value.
workspace_idURL querystring; {"format":"uuid"}NoInstallation setting or machine-reported value.

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$AgentInstallStatusYes—
$.idstring; {"format":"uuid"}YesInstallation setting or machine-reported value.
$.statusstring; {"enum":["waiting","connected","ready","expired","revoked"]}YesInstallation setting or machine-reported value.
$.expires_atstring; {"format":"date-time"}YesInstallation setting or machine-reported value.
$.device_idstring | null; {"format":"uuid"}YesInstallation setting or machine-reported value.
$.heartbeat_acceptedbooleanYesInstallation setting or machine-reported value.
$.measurement_acceptedbooleanYesInstallation setting or machine-reported value.
$.settingsobjectNo—
$.settings.namestringNo—
$.settings.platformstring; {"enum":["unix","windows"]}No—
$.settings.interval_secondsintegerNo—
$.settings.group_idsarray | nullNo—
$.settings.group_ids[]string; {"format":"uuid"}Yes—
$.settings.server_profileAgentProfileNo—
$.settings.server_profile.componentsarray<AgentComponent>; {"maxItems":200}Yes—
$.settings.server_profile.components[]AgentComponentYes—
$.settings.server_profile.components[].addressstringNo—
$.settings.server_profile.components[].familystringNo—
$.settings.server_profile.components[].idstringYes—
$.settings.server_profile.components[].kindstring; {"enum":["system","filesystem","disk","network","process","container","file","program","connection","ping","storage_pool"]}Yes—
$.settings.server_profile.components[].labelstringYes—
$.settings.server_profile.components[].local_refstringNo—
$.settings.server_profile.components[].namestringNo—
$.settings.server_profile.components[].pathstringNo—
$.settings.server_profile.components[].portinteger; {"maximum":65535,"minimum":0}No—
$.settings.server_profile.components[].projectstringNo—
$.settings.server_profile.components[].protocolstringNo—
$.settings.server_profile.components[].text_languagesobjectNo—
$.settings.server_profile.components[].timeout_secondsinteger; {"minimum":0}No—
$.settings.server_profile.components[].translationsobject; {"additionalProperties":false}No—
$.settings.server_profile.components[].translations.deobjectNo—
$.settings.server_profile.components[].translations.enobjectNo—
$.settings.server_profile.components[].transportstringNo—
$.settings.server_profile.components[].filesystem_identitystring; {"maxLength":256}NoAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$.settings.server_profile.components[].disk_identitystring; {"maxLength":256}No—
$.settings.server_profile.selectionsarray<AgentSelection>; {"maxItems":200}Yes—
$.settings.server_profile.selections[]AgentSelectionYes—
$.settings.server_profile.selections[].component_idstringYes—
$.settings.server_profile.selections[].interval_secondsinteger; {"maximum":86400,"minimum":1}Yes—
$.settings.server_profile.selections[].parameter_keystringYes—
$.settings.server_profile.versioninteger; {"const":2}Yes—
$.settings.server_profile.overviewobject; {"additionalProperties":false}NoExplicit targets for the six-chart server overview; select all required readings.
$.settings.server_profile.overview.system_idstring; {"maxLength":128}Yes—
$.settings.server_profile.overview.filesystem_idstring; {"maxLength":128}Yes—
$.settings.server_profile.overview.disk_idstring; {"maxLength":128}Yes—
$.settings.server_profile.overview.network_idstring; {"maxLength":128}Yes—
$.settings.server_profile.filesystem_discoveryobject; {"additionalProperties":false}NoOptional 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.modestring; {"enum":["off","local"]}Yes—
$.settings.server_profile.filesystem_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$.settings.server_profile.system_discoveryobject; {"additionalProperties":false}No—
$.settings.server_profile.system_discovery.modestring; {"enum":["off","local"]}Yes—
$.settings.server_profile.system_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$.settings.server_profile.global_interval_secondsinteger; {"minimum":1,"maximum":86400}NoExplicit global sampling choice. Each source still applies its platform minimum; individual fast rows never imply this choice.

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—

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—

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—

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 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'
python
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())
javascript
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());
go
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)
}