Deploy agent

View as Markdown

Deploys the latest build of an agent to Kubernetes. Creates or updates the K8s namespace, deployment, services, and ingress. Returns 200 on full success or 207 if some resources had errors.

Authentication

AuthorizationBearer
OAuth 2.0 device flow or platform session token

Request

This endpoint expects an object.
accountstringRequired
Account that owns the deployment
namestringRequired
Agent name
source_accountstringOptional

Source account for cross-account deploys (uses latest published version)

user_credentialsmap from strings to stringsOptional

Credential key-value pairs required by the agent

interfaceslist of stringsOptional

Interface adapter names to enable (e.g. [“slack”, “web”])

schedulesmap from strings to stringsOptional
Cron schedules keyed by ingestion name

Response

Deployment succeeded
statusenumOptional
namestringOptional
build_idstringOptional
k8s_namespacestringOptional
deployed_atdatetimeOptional
resourceslist of maps from strings to anyOptional
Kubernetes resources created or updated
service_endpointslist of objectsOptional
errorslist of stringsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error