Accept a legacy relay check-in

Changed on

Accepted for legacy relay clients (v0.11.0–v0.12.4) that still call home with { "name", "properties" } (relay_boot, relay_heartbeat, relay_error, relay_shutdown, relay_killswitch, relay_config_applied, relay_batch_parked, or whatever an older build sends). The body is logged and discarded: nothing is stored, and this is not a configuration channel. It does not return { config: { managed, fingerprint } }. Current relays report themselves with PUT /relays/instances/{instance_id} and read configuration from GET /relays/config. A 204 with an empty body means the event was accepted. Same API-key auth as the other /relays endpoints.

post/relays/events

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Request body

namestring
propertiesobject

Event fields the client allowlists (version, config YAML, queue, routes, stack, …). Logged in full. config may be the relay's YAML; stack is treated as sensitive.

Example request

{
  "name": "relay_heartbeat"
}

Response

Accepted and logged. Empty body. Not a configuration response.

Changes