Skip to main content
ZStack
Infrastructure/Agent Plugins

RegisterPlugin

Register a new plugin into the global plugin registry

POST/api/v1/plugins

Operation ID

RegisterPlugin

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

application/json

Body Fields

  • name
    StringRequired

    Human-readable name of the plugin to register

    Example: nginx-log-collector

  • version
    StringRequired

    Version of the plugin package

    Example: 2.1.0

  • pluginType
    StringRequired

    Plugin type category (log, metric, trace)

    Example: log

  • artifactUrl
    StringRequired

    URL pointing to the downloadable plugin artifact

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

  • checksum
    StringRequired

    SHA256 checksum for verifying artifact integrity

    Example: sha256:abc123def456

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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