Clear an agent's reputation state
Resets an agent's breaker once you've fixed the cause of its elevated bounces or complaints.
Resets an agent's breaker once you've fixed the cause of its elevated bounces or complaints. By default it clears the agent back to healthy, lifting a quarantined block or a review hold; pass ?state= to set a specific state instead (healthy, throttled, quarantined, or review), and any other value returns 400. The breaker evaluates the agent again on its next send, so a still-misbehaving agent can re-trip. An API key cannot lock a state: ?overrideLocked=true returns 403. A time-limited override lock (1 hour by default, at most 24 hours) can be set only from the dashboard by an organization owner or admin, and while it holds this call returns 409. The response returns the agent's state, overrideLocked (always false here), shouldSend, and the updated reputation snapshot, and the action is recorded as an agent.reputation.cleared entry in your audit log; re-issuing the same clear is safe. Requires the agents:write scope and returns 404 if the agent doesn't exist under your account.
Scope: agents:write. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | yes | Agent UUID. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
state | "healthy", "throttled", "quarantined", "review" | no | The state to set. Defaults to healthy (clears a quarantine or review). (default "healthy") |
Response
200 Success. Body: application/json, AgentReputationClearResponse.
| Field | Type | Required | Description |
|---|---|---|---|
agentId | string | yes | |
state | string | yes | |
overrideLocked | boolean | no | True while an operator override lock (set in the dashboard by an owner or admin) pins the state. |
shouldSend | boolean | yes | |
reputation | object or null | no | |
overrideLockedUntil | string (date-time) or null | no | When the override lock ends (at most 24 hours after it was set); null without a lock. |
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
409 | The resource already exists or its state does not allow this (duplicate_resource or a condition-specific code). |
422 | The request is well-formed but a field failed validation (validation_failed). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Get one agent's reputation and should-send verdict
Returns one agent's live reputation: its rolling bounceRate and complaintRate recomputed from the agent's recent delivery outcomes, the current breaker state (healthy, throttled, quarantined, or review), a verdict (allow, throttle, block, review), and a shouldSend boolean that is false only when the agent is quarantined.
List API keys
Returns every API key on the organization — both active and revoked — ordered by createdAt descending, newest first.