Send a heartbeat now

POST

/v1/metering/heartbeat

curl --request POST \
  --url http://localhost:8080/v1/metering/heartbeat

Operator action: builds the month-to-date heartbeat and posts it to metering.endpoint immediately, even when heartbeats are disabled, the install is air-gapped or setup is not activated; the attempt and its outcome are recorded. Answers with sent: false and the reason (rather than an error) when metering.endpoint is not an absolute URL. Administrators only.

Responses

200

OK

Media typeapplication/json

Outcome of one heartbeat run.

object

attempted

required

boolean

delivered

required

boolean

detail

required

string

report

required

One of:

null

null

object

object

id

required

string format: uuid

deliveryMode

required

string

period

required

month for heartbeats (month-to-date), quarter for the air-gapped usage report.

object

kind

required

string

start

required

string format: date

end

required

string format: date

closedLoanCount

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

documentPageCount

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

payload

required

What leaves the bank: install id, version, the period, two integers (closed loans, document pages), coarse health, and the license key for Bookend’s receiver to validate. Never loan data. The wire names are the documented snake_case ones on every surface (heartbeat, signed report, REST) so the payload viewer shows exactly what is sent.

object

install_id

required

string

version

required

string

period

required

month for heartbeats (month-to-date), quarter for the air-gapped usage report.

object

kind

required

string

start

required

string format: date

end

required

string format: date

closed_loan_count

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

document_page_count

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

health

required

Coarse component status words (ok / degraded / unknown); no hostnames, no counts beyond the metered one.

object

database

required

string

inference

required

string

core

required

string

evidence

required

string

license_key

required

null | string

generated_at

required

string format: date-time

signature

required

null | string

signatureKeyId

required

null | string

deliveredAt

required

null | string format: date-time

generatedAt

required

string format: date-time

Example^generated

{
  "attempted": true,
  "delivered": true,
  "detail": "example",
  "report": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "deliveryMode": "example",
    "period": {
      "kind": "example",
      "start": "2026-04-15",
      "end": "2026-04-15"
    },
    "closedLoanCount": 1,
    "documentPageCount": 1,
    "payload": {
      "install_id": "example",
      "version": "example",
      "period": {
        "kind": "example",
        "start": "2026-04-15",
        "end": "2026-04-15"
      },
      "closed_loan_count": 1,
      "document_page_count": 1,
      "health": {
        "database": "example",
        "inference": "example",
        "core": "example",
        "evidence": "example"
      },
      "license_key": "example",
      "generated_at": "2026-04-15T12:00:00Z"
    },
    "signature": "example",
    "signatureKeyId": "example",
    "deliveredAt": "2026-04-15T12:00:00Z",
    "generatedAt": "2026-04-15T12:00:00Z"
  }
}