Skip to main content
ZStack
Infrastructure/Agents

AutoRegisterHeartbeat

Process agent auto-registration and heartbeat in a single combined request

POST/api/v1/agents/heartbeat

Operation ID

AutoRegisterHeartbeat

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • agentId
    StringRequired

    Self-reported unique identifier of the agent

    Example: agent-abc123-def456

  • name
    StringRequired

    Human-readable name of the agent

    Example: prod-agent-01

  • type
    StringRequired

    Type of the agent (log, metric, trace)

    Example: log

  • version
    StringRequired

    Current version of the agent binary

    Example: 1.2.3

  • uptime
    StringRequired

    Seconds the agent process has been running

    Example: 86400

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • accepted
    Boolean

    Whether the heartbeat and auto-registration was accepted

    Example: true

  • agentId
    String

    Assigned or confirmed agent UUID after registration

    Example: agent-abc123-def456