Agent
Is this organisation's agent alive? Returns hasEverRun, lastRunAt, silentDays,…
GET
https://backend.immut.io/api/v1/agent/statusRequired scope: documents:read
Is this organisation's agent alive? Returns hasEverRun, lastRunAt, silentDays, thresholdDays, isAbsent and notifiedAt. lastRunAt is when immut last HEARD from the agent, which is not the same as when it last ran: a sweep that ran and failed to report looks identical to one that never ran, so do not turn this into a claim about whether any file is protected. thresholdDays is the server's own absence threshold, returned so a client cannot drift from the value immut emails on.
Responses
| Status | Meaning |
|---|---|
200 | Success |
400 | BadRequest |
401 | Unauthorized |
403 | Forbidden |
429 | RateLimited |
Example
curl -X GET "https://backend.immut.io/api/v1/agent/status" \
-H "Authorization: Bearer $IMMUT_API_KEY"
Generated from the immut API contract, version 1.9.0. Machine-readable: this page as markdown · everything in one file · OpenAPI