POST Update für die gebundene native Installation übernehmen
/api/v1/agent/updates/{id}/claim
Update für die gebundene native Installation übernehmen
Auf dieser Seite
Zugriff und Rechte
Update für die gebundene native Installation übernehmen
API-Schreibschlüssel in Authorization: Bearer. Er erlaubt Datenübertragungen für die ausgewählten Geräte oder alle Geräte seines Arbeitsbereichs.
Parameter und Header
| Feld | Position | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|---|
| id | Pfad | string; {"format":"uuid"} | Ja | Update für die gebundene native Installation übernehmen |
Anfragekörper
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | AgentUpdateClaim | Ja | — |
| $.installation_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | — |
| $.lease_token | string; {"pattern":"^[0-9a-f]{64}$"} | Ja | — |
Antworten
| Stabile Fehlercodes |
|---|
| unauthorized |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| Stabile Fehlercodes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| owner_required |
| forbidden |
| agent_config_write_required |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| Stabile Fehlercodes |
|---|
| not_found |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| Stabile Fehlercodes |
|---|
| stale |
| not_available |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| Stabile Fehlercodes |
|---|
| invalid |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| Stabile Fehlercodes |
|---|
| quota_exceeded |
| rate_limited |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Retry-After | string; {"pattern":"^[0-9]+$"} | Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
| Stabile Fehlercodes |
|---|
| unavailable |
| update_busy |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Retry-After | string; {"pattern":"^[0-9]+$"} | Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
application/json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | AgentUpdateJob | Ja | — |
| $.id | string; {"format":"uuid"} | Ja | — |
| $.installation_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | — |
| $.state | string; {"enum":["pending","running","succeeded","failed","expired","unconfirmed"]} | Ja | — |
| $.phase | string; {"enum":["downloading","installing","restarting","completed"]} | Ja | — |
| $.target | AgentUpdateTarget | Ja | — |
| $.target.commit | string; {"pattern":"^[0-9a-f]{40}$"} | Ja | — |
| $.target.version | string | Ja | — |
| $.target.created_at | string; {"format":"date-time"} | Ja | — |
| $.target.file | object; {"additionalProperties":false} | Ja | — |
| $.target.file.name | string | Ja | — |
| $.target.file.platform | string; {"enum":["linux","darwin","windows"]} | Ja | — |
| $.target.file.architecture | string; {"enum":["amd64","arm64"]} | Ja | — |
| $.target.file.kind | string; {"const":"binary"} | Ja | — |
| $.target.file.sha256 | string; {"pattern":"^[0-9a-f]{64}$"} | Ja | — |
| $.target.file.size | integer; {"minimum":1,"maximum":268435456} | Ja | — |
| $.requested_at | string; {"format":"date-time"} | Ja | — |
| $.updated_at | string; {"format":"date-time"} | Ja | — |
| $.claimed_at | string; {"format":"date-time"} | null | Ja | — |
| $.claimed_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.claimed_at (anyOf 2) | null | Nein | — |
| $.finished_at | string; {"format":"date-time"} | null | Ja | — |
| $.finished_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.finished_at (anyOf 2) | null | Nein | — |
| $.error_code | string | Ja | — |
| $.monitor_id | string; {"format":"uuid"} | Ja | — |
| $.operation_id | string; {"format":"uuid"} | Ja | — |
| $.source_version | string; {"maxLength":128} | Ja | — |
| $.source_sha256 | string; {"pattern":"^[0-9a-f]{64}$"} | Ja | — |
Wiederholungen und asynchrone Aufträge
Für diese Änderung gibt es keine allgemeine Wiederholungsgarantie. Prüfen Sie bei unklarer Antwort den betroffenen Eintrag, bevor Sie es erneut versuchen. Beachten Sie Wartezeiten aus Retry-After und fordern Sie abgelaufene Anmelde- oder Aktionscodes neu an.
Anfragebeispiele
Ersetzen Sie Demokennungen, Zeitstempel und Platzhalter durch eigene Werte. Behalten Sie bei Wiederholungen Kennungen, Zeit und Inhalt bei. Diese Beispiele führen auf der Seite keine Anfragen aus.
Halten Sie Anmeldelinks, Codes, Cookies und Schlüssel privat. Schreiben Sie sie nicht in Logs und teilen Sie sie nicht in Hilfeanfragen.
curl --silent --show-error --output /dev/null --write-out "%{http_code}\\n" \\
--request POST \\
--header @"$HOME/.config/metribeacon/headers.txt" \\
--header 'Content-Type: application/json' \\
--data-binary '{"installation_id":"00000000000000000000000000000000","lease_token":"0000000000000000000000000000000000000000000000000000000000000000"}' \\
"https://metribeacon.com/api/v1/agent/updates/00000000-0000-4000-8000-000000000001/claim"
import json
from pathlib import Path
from urllib.request import Request, build_opener, HTTPRedirectHandler
headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
headers["Content-Type"] = "application/json"
request = Request('https://metribeacon.com/api/v1/agent/updates/00000000-0000-4000-8000-000000000001/claim', method='POST', data='{"installation_id":"00000000000000000000000000000000","lease_token":"0000000000000000000000000000000000000000000000000000000000000000"}'.encode(), headers=headers)
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
with build_opener(NoRedirect()).open(request, timeout=10) as response:
print(response.status)
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
headers["Content-Type"] = "application/json";
const response = await fetch("https://metribeacon.com/api/v1/agent/updates/00000000-0000-4000-8000-000000000001/claim", { method: "POST", headers, redirect: "manual", signal: AbortSignal.timeout(10000), body: "{\"installation_id\":\"00000000000000000000000000000000\",\"lease_token\":\"0000000000000000000000000000000000000000000000000000000000000000\"}" });
console.log(response.status);
await response.body?.cancel();
package main
import ("bytes"; "encoding/json"; "fmt"; "net/http"; "os"; "path/filepath"; "time")
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("home directory unavailable") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("private headers unavailable") }
headers := map[string]string{}; if json.Unmarshal(raw, &headers) != nil { panic("invalid private headers") }
request, err := http.NewRequest("POST", "https://metribeacon.com/api/v1/agent/updates/00000000-0000-4000-8000-000000000001/claim", bytes.NewBufferString("{\"installation_id\":\"00000000000000000000000000000000\",\"lease_token\":\"0000000000000000000000000000000000000000000000000000000000000000\"}")); if err != nil { panic("request unavailable") }
for key,value := range headers { request.Header.Set(key,value) }; request.Header.Set("Content-Type","application/json")
client := &http.Client{Timeout:10*time.Second,CheckRedirect:func(*http.Request,[]*http.Request)error{return http.ErrUseLastResponse}}
response,err := client.Do(request); if err != nil { panic("request failed; credentials and response omitted") }; defer response.Body.Close(); fmt.Println(response.StatusCode)
}
Verwandte Anleitungen
- HTTP-API, OAuth und MCP
Finden Sie die Nutzer-API-Endpunkte mit Rechten, Feldern, Beispielen und Antwortformaten.
- POST Fortschritt eines nativen Updates melden
Fortschritt eines nativen Updates melden
- GET Gebundene Agentkonfiguration lesen
Lesen Sie die aktuelle Konfiguration und ihre Übernahme durch den Agenten. Prüfintervall und Wiederholungsversand unveränderter Zustände bleiben getrennt. Eigene Definitionen enthalten nur deklarierte Feldtypen und Quellenkennungen, niemals Befehle oder Zugangsdaten.
- PATCH Lokale Änderungen synchronisieren
Verwendet stabile Quellenkennungen. Geänderte Felder werden in der Reihenfolge der Serverannahme übernommen; andere Felder und Messhistorien bleiben erhalten. Wiederholen Sie nach einer verlorenen Antwort dieselbe operation_id und denselben Inhalt. Namen, Beschreibungen, Aktivierungen und Prüfintervalle werden synchronisiert. Programme und Argumente bleiben in der lokal freigegebenen Richtlinie.