Docs API Reference SDK Reference

Docs API Reference SDK Reference

Analytics API
SaaS API

SaaS API agents

Deactivate agent

||View as Markdown|

POST

https://localhost:8080/api/v1/agents/:id/deactivate

POST

/api/v1/agents/:id/deactivate

1 curl -X POST https:https://localhost:8080/api/v1/agents/id/deactivate \
2      -H "Authorization: Authorization" \
3      -H "X-Workspace-Id: X-Workspace-Id"

200Successful

1 {}

Set agent's Virtual Key status to inactive. Owner or admin.

Path parameters

idstringRequired

Agent UUID

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired

Workspace UUID

Response

data: updated agent

Was this page helpful?

Get agent analytics

List agent stream keys