Skip to main content
POST
Agent key only: report hardware, servers, health, filtered engine metrics, and content-free request shapes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

One agent sync. May be gzip-encoded; at most 8 MiB decompressed. Unknown fields are ignored within one protocol version.

agent_version
string
required
Maximum string length: 256
arch
string
required
Maximum string length: 256
hardware
object
required
os
string
required
Maximum string length: 256
protocol
string
required
Allowed value: "infercrane.agent/v1"
sent_at
string<date-time>
required

Agent clock; used to correct request-shape times for clock skew.

servers
object[]
required
Maximum array length: 32
gateway
object
metrics
object[]

Per server: the newest filtered engine scrape and, when available, the oldest scrape of the same engine process in the trailing five minutes.

Maximum array length: 32
traffic
object[]

Content-free request shapes from the agent's local gateway.

Maximum array length: 1000

Response

Success

accepted
object
required
agent_id
string
required
agent_name
string
required
commands
object[]
required

Reserved for candidate runs; protocol v1 sends none.

poll_interval_seconds
integer
required
Required range: 5 <= x <= 60
rejected
object[]
required
servers
object[]
required
upgrade
object
required