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)
| NAME | METHODS | DESCRIPTION |
|---|---|---|
| admission | list, get, admit, reject, revoke, delete | The admission of nodes |
| agent | status, list, get, drain, undrain | Manage the agents in the fleet: discovery, drain and PKI enrollment |
| audit | list, export, get | Read the audit log |
| controller | status | The controller of the fleet |
| facts | list | Read the facts that an input can refer to |
| file | list, upload, get, update, delete, stale | Manage the files in the Object Store |
| health | liveness, ready, status | Check the health of the controller |
| job | list, get, delete, retry | Manage the jobs in the queue |
| nats | status | The NATS server of the fleet |
| telemetry | get | Read telemetry through the controller |
Admission
The admission of nodes. osapi controller endpoint get --name admission shows
Agent
Manage the agents in the fleet: discovery, drain and PKI enrollment.
Audit
Read the audit log. osapi controller endpoint get --name audit shows the same.
Controller
The controller of the fleet. osapi controller endpoint get --name controller
Facts
Read the facts that an input can refer to.
File
Manage the files in the Object Store.
Health
Check the health of the controller.
Job
Manage the jobs in the queue. osapi controller endpoint get --name job shows
NATS
The NATS server of the fleet. osapi controller endpoint get --name nats shows
Telemetry
Read telemetry through the controller.