Skip to content
BookendBookend Docs

Get diagnostics

GET
/v1/diagnostics
curl --request GET \
  --url http://localhost:8080/v1/diagnostics

The one screen an operator reads out to support: version, runtime, operating system, uptime, database provider and schema version, license, metering status, inference probe, core provider, the last evidence-chain sweep, ASP.NET health checks and Quartz scheduled jobs. Contains no loan data. Administrators only.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

One screen an operator can read out to support. Contains no loan data.

object
version
required
string
runtime
required
string
operatingSystem
required
string
generatedAt
required
string format: date-time
startedAt
required
string format: date-time
uptimeSeconds
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
database
required
object
provider
required
string
schemaVersion
required
null | string
appliedScripts
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
lastAppliedAt
required
null | string format: date-time
license
required

What the installed license currently allows.

object
installed
required
boolean
valid
required
boolean
expired
required
boolean
license
required
One of:
null
error
required
null | string
checkedAt
required
string format: date-time
intakeWritable

Intake is read-only once the license has expired; everything already in the system stays reachable.

boolean
metering
required

Where metering stands for the operator screens: mode, last successful heartbeat, whether one has been missed (> 7 days), and the license.

object
heartbeatEnabled
required
boolean
airGapped
required
boolean
endpoint
required
string
installId
required
string
lastDeliveredAt
required
null | string format: date-time
lastAttemptAt
required
null | string format: date-time
lastError
required
null | string
missedHeartbeat
required
boolean
missedHeartbeatAfterDays
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
license
required

What the installed license currently allows.

object
installed
required
boolean
valid
required
boolean
expired
required
boolean
license
required
One of:
null
error
required
null | string
checkedAt
required
string format: date-time
intakeWritable

Intake is read-only once the license has expired; everything already in the system stays reachable.

boolean
inference
required
object
url
required
null | string
ok
required
boolean
detail
required
string
elapsedMs
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
coreProvider
required
string
evidenceSweep
required
One of:
null
health
required
Array<object>

Filled by the host (ASP.NET health checks); the Application service leaves it empty.

object
name
required
string
status
required
string
description
required
null | string
durationMs
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
jobs
required
Array<object>

Filled by the host from the Quartz scheduler.

object
name
required
string
group
required
string
description
required
null | string
previousFireAt
required
null | string format: date-time
nextFireAt
required
null | string format: date-time
triggerState
required
string
Examplegenerated
{
  "version": "example",
  "runtime": "example",
  "operatingSystem": "example",
  "generatedAt": "2026-04-15T12:00:00Z",
  "startedAt": "2026-04-15T12:00:00Z",
  "uptimeSeconds": 1,
  "database": {
    "provider": "example",
    "schemaVersion": "example",
    "appliedScripts": 1,
    "lastAppliedAt": "2026-04-15T12:00:00Z"
  },
  "license": {
    "installed": true,
    "valid": true,
    "expired": true,
    "license": {
      "institution": "example",
      "tier": "example",
      "airGapped": true,
      "expiresAt": "2026-04-15T12:00:00Z",
      "installId": "example"
    },
    "error": "example",
    "checkedAt": "2026-04-15T12:00:00Z",
    "intakeWritable": true
  },
  "metering": {
    "heartbeatEnabled": true,
    "airGapped": true,
    "endpoint": "example",
    "installId": "example",
    "lastDeliveredAt": "2026-04-15T12:00:00Z",
    "lastAttemptAt": "2026-04-15T12:00:00Z",
    "lastError": "example",
    "missedHeartbeat": true,
    "missedHeartbeatAfterDays": 1,
    "license": {
      "installed": true,
      "valid": true,
      "expired": true,
      "license": {
        "institution": "example",
        "tier": "example",
        "airGapped": true,
        "expiresAt": "2026-04-15T12:00:00Z",
        "installId": "example"
      },
      "error": "example",
      "checkedAt": "2026-04-15T12:00:00Z",
      "intakeWritable": true
    }
  },
  "inference": {
    "url": "example",
    "ok": true,
    "detail": "example",
    "elapsedMs": 1
  },
  "coreProvider": "example",
  "evidenceSweep": {
    "at": "2026-04-15T12:00:00Z",
    "loans": 1,
    "broken": [
      "example"
    ]
  },
  "health": [
    {
      "name": "example",
      "status": "example",
      "description": "example",
      "durationMs": 1
    }
  ],
  "jobs": [
    {
      "name": "example",
      "group": "example",
      "description": "example",
      "previousFireAt": "2026-04-15T12:00:00Z",
      "nextFireAt": "2026-04-15T12:00:00Z",
      "triggerState": "example"
    }
  ]
}