Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Suspend Agent

POST /v1/agents/{agentID}/suspend Suspends a machine agent identity, immediately preventing it from creating new sessions, invoking tools, or performing any authenticated operations. Suspension is reversible — the agent can be reactivated by updating its status back to "active" via the update endpoint. All active sessions belonging to the suspended agent are effectively blocked at the access-control layer. Existing session tokens will fail scope checks until the agent is reactivated.
Suspension is the recommended first response for anomalous agent behavior. Use revoke only when permanent decommissioning is required.

​
Authentication

Requires X-API-Key header or Bearer JWT token. Tenant-scoped via X-Tenant-ID.

​
Path Parameters

​
agentID
string
required
The MAIP agent identifier (e.g., maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH).

​
Request Body

​
reason
string
required
Human-readable explanation for the suspension. Recorded in the audit log for compliance review. Maximum 1024 characters.

​
Response

​
status
string
Updated status, always "suspended" on success.
​
agent_id
string
The MAIP agent identifier that was suspended.

​
Example

curl -X POST https://api.truthlocks.com/v1/agents/maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH/suspend \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Anomalous data access pattern detected by velocity scoring at 2026-04-06T15:00:00Z"
  }'

​
Reactivating a Suspended Agent

To restore a suspended agent to active status, use the PATCH /v1/agents/ endpoint: 
curl -X PATCH https://api.truthlocks.com/v1/agents/maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{"status": "active"}'