Skip to main content

Endpoints

An endpoint is one operation of the controller itself, such as the list of agents or the retry of a job. It runs on the controller, in the request, and it has no target and no result for each host. An operation on a host is a behavior. Each group of endpoints is a definition in Go, and osapi builds its routes, its spec and its commands from it. Building an endpoint tells how to write one.

Every endpoint group in this build​

Endpoint groups (10)​

NAMEMETHODSDESCRIPTION
admissionlist, get, admit, reject, revoke, deleteThe admission of nodes
agentstatus, list, get, drain, undrainManage the agents in the fleet: discovery, drain and PKI enrollment
auditlist, export, getRead the audit log
controllerstatusThe controller of the fleet
factslistRead the facts that an input can refer to
filelist, upload, get, update, delete, staleManage the files in the Object Store
healthliveness, ready, statusCheck the health of the controller
joblist, get, delete, retryManage the jobs in the queue
natsstatusThe NATS server of the fleet
telemetrygetRead telemetry through the controller