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

ListPlugins

List all registered plugins in the plugin registry

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of the plugin

      Example: plugin-001-abc

    • nameString

      Human-readable name of the plugin

      Example: nginx-log-collector

    • versionString

      Version of the plugin package

      Example: 2.1.0

    • pluginTypeString

      Plugin type category (e.g. log, metric, trace)

      Example: log

    • artifactUrlString

      Download URL of the plugin binary artifact

      Example: https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz

    • checksumString

      SHA256 checksum of the plugin artifact

      Example: sha256:abc123def456

    • configSchemaString

      JSON schema string for plugin configuration

      Example: {}

    • pluginRuntimeString

      Runtime environment required by the plugin (e.g. go, python)

      Example: go

    • registeredAtString

      Registered at

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

  • totalInteger

    Total number of registered plugins

    Example: 50

  • limitInteger

    Maximum number of items returned

    Example: 20

  • offsetInteger

    Number of items skipped for pagination

    Example: 20

Endpoint

GET/api/v1/plugins

/api/v1/plugins

Operation ID

ListPlugins

Permalink

Request Example

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

Response Example

200
{
  "items": [
    {}
  ],
  "total": 50,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history