Skip to main content
POST
Report a heartbeat from a runner host

Authorizations

X-Outerlayer-App-Id
string
header
required

Factory id the request is scoped to.

Authorization
string
header
required

API key (sk_outerlayer_*)

Headers

Signature
string

HTTP Message Signature (RFC 9421) made with the runner key's host key: runner=:<base64>:.

Signature-Input
string

The signature's covered components and parameters: runner=("@method" "@path" "@query" "content-digest");created=<unix seconds>;nonce="<random>";keyid="<host key fingerprint>";alg="ed25519".

Content-Digest
string

RFC 9530 digest of the request body, always sent, including for a request with none: sha-256=:<base64>:.

Body

application/json
cliVersion
string
required
Required string length: 1 - 64
host
string
required
Required string length: 1 - 255
pollSeconds
integer
required
Required range: 1 <= x <= 86400
slotsTotal
integer
required
Required range: x >= 1
slotsUsed
integer
required
Required range: x >= 0
blocked
object
lastUpdate
object
lowDisk
object
runnerProtocol
integer
Required range: 0 <= x <= 1000000
workRequest
object

Response

The heartbeat is recorded.

data
object
required