Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
POSTAgentSince 1.0SynchronousAuth Required

AutoRegisterHeartbeat

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • agentIdStringRequired

    Self-reported unique identifier of the agent

    Example: agent-abc123-def456

  • nameStringRequired

    Human-readable name of the agent

    Example: prod-agent-01

  • typeStringRequired

    Type of the agent (log, metric, trace)

    Example: log

  • versionStringRequired

    Current version of the agent binary

    Example: 1.2.3

  • uptimeStringRequired

    Seconds the agent process has been running

    Example: 86400

Responses

200 OK

On success, this API returns the following response structure.

  • acceptedBoolean

    Whether the heartbeat and auto-registration was accepted

    Example: true

  • agentIdString

    Assigned or confirmed agent UUID after registration

    Example: agent-abc123-def456

Endpoint

POST/api/v1/agents/heartbeat

/api/v1/agents/heartbeat

Operation ID

AutoRegisterHeartbeat

Permalink

Request Example

curl -X POST '{host}/api/v1/agents/heartbeat' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"agentId":"agent-abc123-def456","name":"prod-agent-01","type":"log","version":"1.2.3","uptime":86400,"cpu":12.5,"memory":35.2,"queueDepth":4}'

Response Example

200
{
  "accepted": true,
  "agentId": "agent-abc123-def456"
}

Change History

This API has no change history records yet.

View all change history