# Check the whole install

Source: <https://everruns.com/docs/api/operations/run_system_doctor/>

[Docs](https://everruns.com/docs/)/[API reference](https://everruns.com/docs/api/)/[Operations & billing](https://everruns.com/docs/api/groups/operations-billing/)/Check the whole install

# Check the whole install

Preview

Operate durable execution, schedules, sandbox infrastructure, budgets, payments and audit logs.

Public APIEverruns Cloud and self-hosted Platform

GET`/v1/system/doctor`

See [authentication](https://everruns.com/docs/sre/runbooks/authentication/) for credentials and permissions.

## Parameters

### Query Parameters

**refresh**

boolean

Run every check now instead of returning the report from the last minute

## Responses

200Health of every part of the install

### 200

Health of every part of the install

Media typeapplication/json

The whole install’s health.

object

**auth_mode**

required

Authentication mode.

string

**checked_at**

required

When the checks ran.

string format: date-time

**checks**

required

Every check, problems first.

Array\<object>

One check’s outcome, written for an operator: what is true, why it matters, and what to do.

object

**area**

required

The part of the install a check covers. The order is the display order.

string

Allowed values: control_plane database workers security messaging storage observability models integrations

**fix**

How to fix it.

string | null

**id**

required

Stable identifier, `area.name`.

string

**observed_at**

required

When the check observed this.

string format: date-time

**status**

required

How a check came out. Ordered from best to worst so the report’s verdict is the maximum.

string

Allowed values: ok info warning problem

**summary**

required

What the check found, in one sentence.

string

**title**

required

Short name of what is checked.

string

**why**

What goes wrong if this is not fixed.

string | null

**grade**

required

Deployment grade (`dev`, `poc`, `preview`, `prod`). Decides how strict the security checks are.

string

**setup**

required

What the doctor found this install is made of, one fact per entry.

Array\<string>

**status**

required

The worst status of any check.

string

Allowed values: ok info warning problem

**version**

required

Server build version.

string

### Example

```json
{
  "auth_mode": "full",
  "checks": [
    {
      "area": "control_plane",
      "id": "database.migrations",
      "status": "ok",
      "summary": "All 14 migrations are applied.",
      "title": "Migrations applied"
    }
  ],
  "grade": "prod",
  "setup": [
    "Postgres 16.4",
    "3 workers",
    "NATS",
    "S3 blob storage"
  ],
  "status": "ok",
  "version": "0.50.0"
}
```

401Authentication required

### 401

Authentication required

403Platform user access is required

### 403

Platform user access is required

Media typeapplication/json

Standard error response.

Wire shape is [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457): every error response includes `title` and `status`, and may include `detail`, `code`, `allowed_actions`, `retry_after_seconds`, `instance`, and `type`. The content type is rewritten to `application/problem+json` with the `application/problem+json` content type.

object

**allowed_actions**

Recovery actions the caller can take next.

Array\<object>

Agent-actionable link describing a follow-up the caller can take. Used in two contexts:

* **Error recovery** — `ErrorResponse.allowed_actions` carries `rel`s like `retry`, `retry-later`, `unarchive`, `get-existing` so the agent knows the right next call after a 4xx/429.
* **Entity hypermedia** — `WithUrls<T>.allowed_actions` carries state-aware `rel`s like `cancel`, `events`, `self`, `update` on the entity itself so the agent can follow links instead of reconstructing routes from prose.

The shape is intentionally identical across both contexts; the closed `rel` vocabulary distinguishes them.

object

**hint**

Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”, “Cancel the active turn for this session.”).

string | null

**href**

Absolute (preferred) or relative URL the caller may invoke directly. **Always present on entity hypermedia actions** (`WithUrls<T>.allowed_actions`); **optional on error-recovery actions** (`ErrorResponse.allowed_actions`) where the matching `operation_id` is enough and the URI is implicit from the failed call.

string | null

**method**

HTTP method to use against `href`. Required for entity hypermedia actions; usually omitted on error-recovery actions where the same operation is retried with its original method.

string | null

**operation_id**

OpenAPI `operationId` the caller should invoke. Lets an MCP client resolve the call without parsing `href`.

string | null

**rel**

required

Link relation describing the action. Examples: `self`, `cancel`, `pause`, `resume`, `events`, `retry`, `retry-later`, `unarchive`, `get-existing`, `delete`, `update`.

string

**schema_ref**

OpenAPI `$ref` to the request-body schema, when the action takes one (e.g. `#/components/schemas/UpdateSessionRequest`). Lets a tool-calling agent fetch the input shape without scanning the whole spec.

string | null

**code**

Stable, machine-readable error code (snake_case).

string | null

**detail**

Human-readable explanation specific to this occurrence.

string | null

**instance**

Request URI for this occurrence.

string | null

**retry_after_seconds**

Seconds the caller should wait before retrying (429 / transient 503).

integer | null format: int32

**status**

required

HTTP status code; mirrors the response status line.

integer format: int32

**title**

required

Short, human-readable summary of the problem (e.g. “Not Found”).

string

**type**

RFC 9457 problem type URI. Optional; identifies the problem class.

string | null

### Example

```json
{
  "allowed_actions": [
    {
      "method": "POST"
    }
  ],
  "code": "session_not_found",
  "detail": "Session session_01933b5a000070008000000000000001 not found in org org_01933b5a000070008000000000000001.",
  "instance": "/v1/sessions/session_01933b5a000070008000000000000001",
  "retry_after_seconds": 30,
  "status": 404,
  "title": "Session not found",
  "type": "https://everruns.com/docs/errors/session_not_found"
}
```

503The system doctor is not available

### 503

The system doctor is not available

Media typeapplication/json

Standard error response.

Wire shape is [RFC 9457 Problem Details](https://www.rfc-editor.org/rfc/rfc9457): every error response includes `title` and `status`, and may include `detail`, `code`, `allowed_actions`, `retry_after_seconds`, `instance`, and `type`. The content type is rewritten to `application/problem+json` with the `application/problem+json` content type.

object

**allowed_actions**

Recovery actions the caller can take next.

Array\<object>

Agent-actionable link describing a follow-up the caller can take. Used in two contexts:

* **Error recovery** — `ErrorResponse.allowed_actions` carries `rel`s like `retry`, `retry-later`, `unarchive`, `get-existing` so the agent knows the right next call after a 4xx/429.
* **Entity hypermedia** — `WithUrls<T>.allowed_actions` carries state-aware `rel`s like `cancel`, `events`, `self`, `update` on the entity itself so the agent can follow links instead of reconstructing routes from prose.

The shape is intentionally identical across both contexts; the closed `rel` vocabulary distinguishes them.

object

**hint**

Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”, “Cancel the active turn for this session.”).

string | null

**href**

Absolute (preferred) or relative URL the caller may invoke directly. **Always present on entity hypermedia actions** (`WithUrls<T>.allowed_actions`); **optional on error-recovery actions** (`ErrorResponse.allowed_actions`) where the matching `operation_id` is enough and the URI is implicit from the failed call.

string | null

**method**

HTTP method to use against `href`. Required for entity hypermedia actions; usually omitted on error-recovery actions where the same operation is retried with its original method.

string | null

**operation_id**

OpenAPI `operationId` the caller should invoke. Lets an MCP client resolve the call without parsing `href`.

string | null

**rel**

required

Link relation describing the action. Examples: `self`, `cancel`, `pause`, `resume`, `events`, `retry`, `retry-later`, `unarchive`, `get-existing`, `delete`, `update`.

string

**schema_ref**

OpenAPI `$ref` to the request-body schema, when the action takes one (e.g. `#/components/schemas/UpdateSessionRequest`). Lets a tool-calling agent fetch the input shape without scanning the whole spec.

string | null

**code**

Stable, machine-readable error code (snake_case).

string | null

**detail**

Human-readable explanation specific to this occurrence.

string | null

**instance**

Request URI for this occurrence.

string | null

**retry_after_seconds**

Seconds the caller should wait before retrying (429 / transient 503).

integer | null format: int32

**status**

required

HTTP status code; mirrors the response status line.

integer format: int32

**title**

required

Short, human-readable summary of the problem (e.g. “Not Found”).

string

**type**

RFC 9457 problem type URI. Optional; identifies the problem class.

string | null

### Example

```json
{
  "allowed_actions": [
    {
      "method": "POST"
    }
  ],
  "code": "session_not_found",
  "detail": "Session session_01933b5a000070008000000000000001 not found in org org_01933b5a000070008000000000000001.",
  "instance": "/v1/sessions/session_01933b5a000070008000000000000001",
  "retry_after_seconds": 30,
  "status": 404,
  "title": "Session not found",
  "type": "https://everruns.com/docs/errors/session_not_found"
}
```

FetchcURL

Request

```js
const url = 'https://app.everruns.com/api/v1/system/doctor';
const options = {method: 'GET'};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

Request

```sh
curl --request GET \
  --url https://app.everruns.com/api/v1/system/doctor
```

Additional language examples require JavaScript. The default request example is available above.

200401403503

200 · Health of every part of the install

```json
{
  "auth_mode": "full",
  "checked_at": "2026-10-12T09:00:00Z",
  "checks": [
    {
      "area": "control_plane",
      "id": "database.migrations",
      "observed_at": "2026-10-12T09:00:00Z",
      "status": "ok",
      "summary": "All 14 migrations are applied.",
      "title": "Migrations applied"
    }
  ],
  "grade": "prod",
  "setup": [
    "Postgres 16.4",
    "3 workers",
    "NATS",
    "S3 blob storage"
  ],
  "status": "ok",
  "version": "0.50.0"
}
```

401 · Authentication required

No response body example is declared for this status.

403 · Platform user access is required

```json
{
  "title": "Platform user access is required",
  "status": 403
}
```

503 · The system doctor is not available

```json
{
  "title": "The system doctor is not available",
  "status": 503
}
```

## Matching endpoints