Skip to main content
ZStack
Infrastructure/Agents

GetPluginTelemetry

Retrieve real-time telemetry metrics for a plugin running on a specific agent

GET/api/v1/agents/{agentId}/plugins/{pluginId}/telemetry

Operation ID

GetPluginTelemetry

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

Path Parameters

  • agentId
    StringRequired

    UUID of the agent running the plugin

  • pluginId
    StringRequired

    Unique identifier of the plugin to query

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • pluginId
    String

    Unique identifier of the plugin

    Example: plugin-001-abc

  • agentId
    String

    UUID of the agent running the plugin

    Example: agent-abc123-def456

  • status
    String

    Current plugin status (running, stopped, crashed)

    Example: running

  • collectRate
    Long

    Data collection rate in records per second

    Example: 150.5

  • errorRate
    Long

    Error rate as a fraction of total operations (0-1)

    Example: 0.02

  • lastCollectionAt
    String

    Last collection at

    Example: 2026-01-15T08:00:00Z

  • memoryMb
    Long

    Memory consumed by the plugin process in megabytes

    Example: 48.5

  • crashCount
    Integer

    Number of times the plugin process has crashed

    Example: 2

  • lastCrashAt
    String

    Last crash at

    Example: 2026-01-15T08:00:00Z