fleet

POST `/v1/fleet/commands/{commandId}/result`

Report how a claimed host command ended.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X POST https://api.zinndigital.com/v1/fleet/commands/{commandId}/result \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "ok": <boolean> }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

A command belonging to a **different** host answers `404`, byte-identical to the answer for a command that does not exist — distinguishing them would make this an enumeration oracle for other hosts' command ids. `result` is one redacted line, never raw command output.

Parameters

Naam	Type	Verplicht	Wat dit is
`commandId (path)`	`string`	Ja	A command claimed for this host in a heartbeat response.

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`ok`	`boolean`	Ja	—
`result`	`string`	Nee	One redacted line, never raw command output. Truncated keeping BOTH ENDS: a traceback puts its exception on the last line, so a head-only cut discards exactly the words that say…
`exit_code`	`integer`	Nee	The process exit status, when a process ran, and the field that separates a VERDICT from a CRASH. `lsws_suexec.py check` exits 3 when it has looked and found a broken per-site i…
`inventory`	`object`	Nee	The software inventory document, sent only when the command was a `software_inventory`. A DOCUMENT rather than a result line, because `result` is capped at 255 characters on pur…

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`string`	Nee	—
`status`	`string`	Nee	—

Fouten die dit eindpunt kan retourneren

401 · 404 · 422 · 429

POST /v1/fleet/commands/{commandId}/result