MetriBeacon
Menu

POST Approve the device and its separate CLI/MCP management credential

/api/v1/agent/device-link

Requires CSRF. Select an owned workspace or create one; choose an unconfigured server or create one. Defaults select CPU, RAM and the system filesystem at 30 seconds. Account quotas are enforced in the same transaction. Replays by the same account do not create more keys; another account cannot approve an already completed request.

On this page

Access and permissions

Requires CSRF. Select an owned workspace or create one; choose an unconfigured server or create one. Defaults select CPU, RAM and the system filesystem at 30 seconds. Account quotas are enforced in the same transaction. Replays by the same account do not create more keys; another account cannot approve an already completed request.

Browser session: __Host-mb_session cookie.

Parameters and headers

No path, query or additional request-header parameters.

Request body

FieldType and limitsRequiredMeaning
$DeviceLinkApprovalYes—
$.codestring; {"pattern":"^[0-9]{8}$"}Yes—
$.device_idstring; {"format":"uuid"}No—
$.namestring; {"maxLength":128,"minLength":1}Yes—
$.selectionsarray<AgentSelection>; {"maxItems":200}No—
$.selections[]AgentSelectionYes—
$.selections[].component_idstringYes—
$.selections[].interval_secondsinteger; {"maximum":86400,"minimum":1}Yes—
$.selections[].parameter_keystringYes—
$.workspace_idstring; {"format":"uuid"}No—
$.workspace_namestring; {"maxLength":128,"minLength":1}No—
$.server_profileServerProfileRequestNo—
$.server_profile.componentsarray<object>; {"maxItems":200} | nullNoDiscovered or explicitly selected server components.
$.server_profile.components (anyOf 1)array<object>; {"maxItems":200}No—
$.server_profile.components (anyOf 1)[]objectYes—
$.server_profile.components (anyOf 1)[].addressstringNo—
$.server_profile.components (anyOf 1)[].familystringNo—
$.server_profile.components (anyOf 1)[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.server_profile.components (anyOf 1)[].kindstringYesResource kind or measurement type selected from the listed values.
$.server_profile.components (anyOf 1)[].labelstring; {"maxLength":128,"minLength":1}YesDisplay name for the component.
$.server_profile.components (anyOf 1)[].local_refstringNo—
$.server_profile.components (anyOf 1)[].namestringNoHuman-readable resource name. Follow the listed length limit.
$.server_profile.components (anyOf 1)[].pathstring; {"maxLength":1024}No—
$.server_profile.components (anyOf 1)[].portintegerNo—
$.server_profile.components (anyOf 1)[].projectstringNo—
$.server_profile.components (anyOf 1)[].protocolstringNo—
$.server_profile.components (anyOf 1)[].text_languagesobjectNo—
$.server_profile.components (anyOf 1)[].timeout_secondsintegerNo—
$.server_profile.components (anyOf 1)[].translationsobject; {"additionalProperties":false}No—
$.server_profile.components (anyOf 1)[].translations.deobjectNo—
$.server_profile.components (anyOf 1)[].translations.enobjectNo—
$.server_profile.components (anyOf 1)[].transportstringNo—
$.server_profile.components (anyOf 1)[].filesystem_identitystring; {"maxLength":256}NoAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$.server_profile.components (anyOf 1)[].disk_identitystring; {"maxLength":256}No—
$.server_profile.components (anyOf 2)nullNo—
$.server_profile.selectionsarray<object>; {"maxItems":200} | nullNoSelected component/parameter pairs and sampling intervals.
$.server_profile.selections (anyOf 1)array<object>; {"maxItems":200}No—
$.server_profile.selections (anyOf 1)[]objectYes—
$.server_profile.selections (anyOf 1)[].component_idstringYesStable identifier of the selected or discovered component.
$.server_profile.selections (anyOf 1)[].interval_secondsinteger; {"maximum":86400,"minimum":0}NoSampling or check interval in seconds within the stated bounds.
$.server_profile.selections (anyOf 1)[].parameter_keystringYesStable parameter identifier from the server catalog.
$.server_profile.selections (anyOf 2)nullNo—
$.server_profile.versionJSON; {"const":2}Yes—
$.server_profile.overviewobject; {"additionalProperties":false}NoExplicit targets for the six-chart server overview; select all required readings.
$.server_profile.overview.system_idstring; {"maxLength":128}Yes—
$.server_profile.overview.filesystem_idstring; {"maxLength":128}Yes—
$.server_profile.overview.disk_idstring; {"maxLength":128}Yes—
$.server_profile.overview.network_idstring; {"maxLength":128}Yes—
$.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.
$.server_profile.filesystem_discovery.modestring; {"enum":["off","local"]}Yes—
$.server_profile.filesystem_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$.server_profile.system_discoveryobject; {"additionalProperties":false}No—
$.server_profile.system_discovery.modestring; {"enum":["off","local"]}Yes—
$.server_profile.system_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$.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.

Responses

application/json

FieldType and limitsRequiredMeaning
$object; {"additionalProperties":false}Yes—
$.approvedbooleanYes—
$.replayedbooleanYes—
Stable error codes
invalid_link
not_found
Stable error codes
revision_conflict
Stable error codes
invalid_link
invalid_profile
unsupported_parameter
Stable error codes
creation_quota
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 POST https://metribeacon.com/api/v1/agent/device-link --header 'Accept: application/json' --header 'Cookie: __Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF' --header 'Content-Type: application/json' --header 'Origin: https://metribeacon.com' --header 'X-CSRF-Token: YOUR_CSRF' --data '{"code":"12345678","name":"Demo device"}'
python
import urllib.request
headers = {'Accept': 'application/json', 'Cookie': '__Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF', 'Content-Type': 'application/json', 'Origin': 'https://metribeacon.com', 'X-CSRF-Token': 'YOUR_CSRF'}
request = urllib.request.Request('https://metribeacon.com/api/v1/agent/device-link', headers=headers, method='POST', data='{"code":"12345678","name":"Demo device"}'.encode())
with urllib.request.urlopen(request) as response:
    print(response.read().decode())
javascript
const response = await fetch("https://metribeacon.com/api/v1/agent/device-link", {"method": "POST", "headers": {"Accept": "application/json", "Cookie": "__Host-mb_session=YOUR_SESSION; __Host-mb_csrf=YOUR_CSRF", "Content-Type": "application/json", "Origin": "https://metribeacon.com", "X-CSRF-Token": "YOUR_CSRF"}, "body": "{\"code\":\"12345678\",\"name\":\"Demo device\"}"});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());
go
package main
import ("fmt"; "io"; "net/http"; "strings")
func main() {
 req, err := http.NewRequest("POST", "https://metribeacon.com/api/v1/agent/device-link", strings.NewReader("{\"code\":\"12345678\",\"name\":\"Demo device\"}")); 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")
 req.Header.Set("Content-Type", "application/json")
 req.Header.Set("Origin", "https://metribeacon.com")
 req.Header.Set("X-CSRF-Token", "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)
}