<!--
  immut documentation, machine-readable.

  Everything in one file:  https://www.immut.io/llms-full.txt
    What immut is, which integration path to choose, authentication and scopes, and the COMPLETE
    API reference: every endpoint with parameters, responses and a runnable curl. Fetch this first
    if you intend to call the API.

  Index of all pages:      https://www.immut.io/llms.txt
  OpenAPI contract:        https://www.immut.io/docs/openapi.json
  This page as HTML:       https://www.immut.io/docs/api/agent/get-agent-status

  Any page on this site is available as raw markdown by appending .md to its URL.
-->


# Is this organisation's agent alive? Returns hasEverRun, lastRunAt, silentDays,…

`GET /agent/status`

**Required 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

```bash
curl -X GET "https://backend.immut.io/api/v1/agent/status" \
  -H "Authorization: Bearer $IMMUT_API_KEY"
```

## OpenAPI fragment

```json
{
  "/agent/status": {
    "get": {
      "operationId": "getagentstatus",
      "summary": "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.",
      "description": "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": {
        "200": {
          "description": "Success"
        },
        "400": {
          "$ref": "#/components/responses/BadRequest"
        },
        "401": {
          "$ref": "#/components/responses/Unauthorized"
        },
        "403": {
          "$ref": "#/components/responses/Forbidden"
        },
        "429": {
          "$ref": "#/components/responses/RateLimited"
        }
      },
      "tags": [
        "Agent"
      ],
      "x-required-scope": "documents:read"
    }
  }
}
```