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

GetPluginTelemetry

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

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • agentIdStringRequired

    UUID of the agent running the plugin

  • pluginIdStringRequired

    Unique identifier of the plugin to query

Responses

200 OK

On success, this API returns the following response structure.

  • pluginIdString

    Unique identifier of the plugin

    Example: plugin-001-abc

  • agentIdString

    UUID of the agent running the plugin

    Example: agent-abc123-def456

  • statusString

    Current plugin status (running, stopped, crashed)

    Example: running

  • collectRateLong

    Data collection rate in records per second

    Example: 150.5

  • errorRateLong

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

    Example: 0.02

  • lastCollectionAtString

    Last collection at

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

  • memoryMbLong

    Memory consumed by the plugin process in megabytes

    Example: 48.5

  • crashCountInteger

    Number of times the plugin process has crashed

    Example: 2

  • lastCrashAtString

    Last crash at

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

Endpoint

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

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

Operation ID

GetPluginTelemetry

Permalink

Request Example

curl -X GET '{host}/api/v1/agents/{agentId}/plugins/{pluginId}/telemetry' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "pluginId": "plugin-001-abc",
  "agentId": "agent-abc123-def456",
  "status": "running",
  "collectRate": 150.5,
  "errorRate": 0.02,
  "lastCollectionAt": "example",
  "memoryMb": 48.5,
  "crashCount": 2
}

Change History

This API has no change history records yet.

View all change history