Skip to main content
ZStack
Infrastructure/Agent Plugins

ListPlugins

List all registered plugins in the plugin registry

GET/api/v1/plugins

Operation ID

ListPlugins

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • id
      String

      Unique identifier of the plugin

      Example: plugin-001-abc

    • name
      String

      Human-readable name of the plugin

      Example: nginx-log-collector

    • version
      String

      Version of the plugin package

      Example: 2.1.0

    • pluginType
      String

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

      Example: log

    • artifactUrl
      String

      Download URL of the plugin binary artifact

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

    • checksum
      String

      SHA256 checksum of the plugin artifact

      Example: sha256:abc123def456

    • configSchema
      String

      JSON schema string for plugin configuration

      Example: {}

    • pluginRuntime
      String

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

      Example: go

    • registeredAt
      String

      Registered at

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

  • total
    Integer

    Total number of registered plugins

    Example: 50

  • limit
    Integer

    Maximum number of items returned

    Example: 20

  • offset
    Integer

    Number of items skipped for pagination

    Example: 20