fleet

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

Report how a claimed host command ended.

Все эндпоинты fleet

Вся документация для разработчиков

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

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.

Параметры

ИмяТипОбязательноЧто это
commandId (path)stringДаA command claimed for this host in a heartbeat response.

Тело запроса

ИмяТипОбязательноЧто это
okbooleanДа
resultstringНет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_codeintegerНет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…
inventoryobjectНет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…

Ответ

ИмяТипОбязательноЧто это
idstringНет
statusstringНет

Ошибки, которые может возвращать этот эндпоинт

401 · 404 · 422 · 429