The Deployment API manages the binding of an Agent to a trigger configuration (manual or scheduled). When triggered, a Deployment creates a Deployment Run that starts a session, sends initial events to the Agent, and tracks the execution lifecycle.
Overview
A Deployment binds an Agent with a trigger configuration. Triggers can be manual (via the Run API) or scheduled (via a cron expression). Each trigger creates a Deployment Run, which spins up a session, sends the configured initial events to the Agent, and records the execution status. A Deployment can be paused to stop scheduled triggers and resumed later. Archiving retires a Deployment; archived Deployments cannot be updated, paused, or unpaused.
Deployment operations
| Operation | Endpoint | Description |
|---|---|---|
| Create Deployment | POST /deployments | Create a Deployment, binding an Agent and configuring the trigger method |
| Get Deployment | GET /deployments/{deployment_id} | Get the details of a single Deployment by ID |
| List Deployments | GET /deployments | Paginated list; supports filtering by Agent, status, and keyword |
| Update Deployment | POST /deployments/{deployment_id} | Update the configuration of a Deployment |
| Archive Deployment | POST /deployments/{deployment_id}/archive | Archive a Deployment; the operation is idempotent |
| Run Deployment | POST /deployments/{deployment_id}/run | Manually trigger a single Deployment execution |
| Pause Deployment | POST /deployments/{deployment_id}/pause | Pause a Deployment, stopping scheduled triggers |
| Unpause Deployment | POST /deployments/{deployment_id}/unpause | Resume a paused Deployment to active status |
Deployment Run operations
| Operation | Endpoint | Description |
|---|---|---|
| Get Deployment Run | GET /deployment_runs/{deployment_run_id} | Get the details of a single Deployment Run |
| List Deployment Runs | GET /deployments/{deployment_id}/runs | Paginated list of execution records for a Deployment |