Skip to main content
Infrastructure/Agents

InstallPlugin

Install a plugin onto a specific agent by triggering an async install task

POST/api/v1/agents/{agentId}/plugins/{pluginId}/install

Operation ID

InstallPlugin

Since

1.0.0

Execution Mode

Asynchronous

Auth Context

Auth Required

Async Workflow

This endpoint starts asynchronous work.

Expect an initial acceptance response first, then follow the workflow-specific identifier or task status from the response payload.

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • agentId
    StringRequired

    UUID of the agent on which to install the plugin

  • pluginId
    StringRequired

    Unique identifier of the plugin to install

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • installTaskId
    String

    Task ID for tracking the asynchronous install operation

    Example: task-install-xyz789