fleet

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

Report how a claimed host command ended.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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> }'

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`commandId (path)`	`string`	Sí	A command claimed for this host in a heartbeat response.

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`ok`	`boolean`	Sí	—
`result`	`string`	No	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`	No	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`	No	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…

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`id`	`string`	No	—
`status`	`string`	No	—

Errores que este endpoint puede devolver

401 · 404 · 422 · 429

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