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

RegisterPlugin

Register a new plugin into the global plugin registry

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable name of the plugin to register

    Example: nginx-log-collector

  • versionStringRequired

    Version of the plugin package

    Example: 2.1.0

  • pluginTypeStringRequired

    Plugin type category (log, metric, trace)

    Example: log

  • artifactUrlStringRequired

    URL pointing to the downloadable plugin artifact

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

  • checksumStringRequired

    SHA256 checksum for verifying artifact integrity

    Example: sha256:abc123def456

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

POST/api/v1/plugins

/api/v1/plugins

Operation ID

RegisterPlugin

Permalink

Request Example

curl -X POST '{host}/api/v1/plugins' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"nginx-log-collector","version":"2.1.0","pluginType":"log","artifactUrl":"https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz","checksum":"sha256:abc123def456","configSchema":"{}","pluginRuntime":"go"}'

Response Example

200
{
  "id": "plugin-001-abc",
  "name": "nginx-log-collector",
  "version": "2.1.0",
  "pluginType": "log",
  "artifactUrl": "https://artifacts.example.com/plugins/nginx-log-collector-2.1.0.tar.gz",
  "checksum": "sha256:abc123def456",
  "configSchema": "{}",
  "pluginRuntime": "go"
}

Change History

This API has no change history records yet.

View all change history