Skip to main content

Module api

Module api 

Source

Structs§

AcquireRequest
Body of POST /leases.
AcquireResponse
Response of POST /leases.
BindRequest
Body of POST /leases/{id}/bind: the PreToolUse hook let a command run under the lease.
CanFitRequest
Body of POST /can-fit.
DeliveredResponse
Response of POST /notices/{id}/delivered.
HealthResponse
Response of GET /health.
HeartbeatResponse
Response of POST /leases/{id}/heartbeat.
HistoryResponse
Response of GET /history.
HistoryRunsQuery
Query string of GET /history/runs.
HistoryRunsResponse
Response of GET /history/runs.
JobSummary
What the history knows about one fingerprint.
KillResponse
Response of POST /leases/{id}/kill.
KilledProcess
A process a kill terminated.
LeaseOwner
Query string of POST /leases/{id}/heartbeat, POST /leases/{id}/wait, POST /leases/{id}/bind, DELETE /leases/{id}, GET /notices, and POST /notices/{id}/delivered.
LeaseQuery
Query string of GET /leases. Each filter is optional; an empty query lists every lease.
LeasesResponse
Response of GET /leases.
NoticesResponse
Response of GET /notices.
RegisterSessionRequest
Body of POST /sessions. Registering the same session again is harmless; the daemon forgets a session once its holder process is gone.
ReleaseResponse
Response of DELETE /leases/{id}.
RemoveResponse
Response of POST /leases/{id}/remove.
SessionsResponse
Response of GET /sessions.
UnkilledProcess
A process in a killed tree that is still running.
Verdict
The admission engine’s answer. Response of POST /can-fit.
WaitRequest
Body of POST /leases/{id}/wait: keep waiting for a queued lease without losing its place.

Enums§

BenchmarkProgress
Where a waiting benchmark lease stands, so its holder can report progress.
ProfileSpec
How a request states the resources a job needs.

Constants§

REASON_BEYOND_LEASES
The reason a verdict gives when ending every lease would still leave too little room, so only something outside Allot can make the request fit, if anything can.