Moderation
StableGenerated from capsule-server/openapi.json, the OpenAPI 3.2 document
capsule-server emits and mise run openapi-check-kynos keeps current. To change a
description on this page, change the annotation on the handler or model it comes from
and regenerate — this file is build output. The auth model, error contract, and
conventions common to every endpoint are on the REST API overview.
GET /v1/moderation/record
Section titled “GET /v1/moderation/record”Serve the caller’s own moderation record.
Authentication: required — bearer.
| Parameter | In | Type | Description |
|---|---|---|---|
X-Capsule-Crypto-Suite | header | integer | The crypto suite id from the primitives inventory. Sent on writes; a suite this server does not implement is refused with 400. |
X-Capsule-Protocol | header | string | Required. The YYYY-MM-DD protocol version this request is written against. Outside the server’s [X-Capsule-Protocol-Min, X-Capsule-Protocol-Max] window the request is refused with 426. |
X-Capsule-Sidecar-Schema | header | integer | The sidecar schema version declared at sidecar_schema field 0. Sent on metadata updates; a schema newer than this server indexes is refused with 400. |
| Status | Body | Description |
|---|---|---|
200 | ModerationRecordResponse application/json | OK. Headers: X-Capsule-Min-Client-Build, X-Capsule-Protocol-Max, X-Capsule-Protocol-Min. |
400 | CodedProblem application/problem+json | Malformed handshake. Headers: X-Capsule-Min-Client-Build, X-Capsule-Protocol-Max, X-Capsule-Protocol-Min. |
401 | CodedProblem application/problem+json | Unauthorized. Headers: WWW-Authenticate, X-Capsule-Min-Client-Build, X-Capsule-Protocol-Max, X-Capsule-Protocol-Min. |
403 | CodedProblem application/problem+json | Forbidden. Headers: X-Capsule-Min-Client-Build, X-Capsule-Protocol-Max, X-Capsule-Protocol-Min. |
413 | — | the request body exceeds the configured limit. Headers: X-Capsule-Min-Client-Build, X-Capsule-Protocol-Max, X-Capsule-Protocol-Min. |
500 | CodedProblem application/problem+json | Internal server error. Headers: X-Capsule-Min-Client-Build, X-Capsule-Protocol-Max, X-Capsule-Protocol-Min. |
Schemas
Section titled “Schemas”The models these endpoints carry. A field whose type names another model links to it when this page documents that model, which it does when some path from an operation reaches it within 4 references. A model only ever reached deeper than that is named without being expanded.
CodedProblem
Section titled “CodedProblem”An RFC 9457 problem detail.
| Field | Type | Description |
|---|---|---|
type | string | Required. |
title | string | — |
status | integer | Required. |
detail | string | — |
instance | string | — |
code | string | Required. The stable error.* catalog code. The client localizes this; detail stays English. Present on every problem this server renders. |
ModerationEventResponse
Section titled “ModerationEventResponse”One thing that was done to the account.
| Field | Type | Description |
|---|---|---|
action | string | Required. What was done: suspended, reinstated, taken_down, legal_hold, hold_lifted. |
asset_id | string | null | The asset, when the action was about one rather than about the account. |
at | string | Required. When it happened, RFC 3339. |
reason | string | null | Why, where policy permits. Absent is a real answer — a legal hold may come with an obligation not to disclose it — and reads as “we are not able to say”, which is honest where a fabricated reason would not be. |
ModerationRecordResponse
Section titled “ModerationRecordResponse”The caller’s moderation record.
| Field | Type | Description |
|---|---|---|
standing | string | Required. active or suspended. |
suspended_since | string | null | When a suspension began, RFC 3339. Absent while the account is active. |
events | ModerationEventResponse[] | Required. Everything done to this account, oldest first. A reinstatement does not erase the suspension it lifted: the record is what a user reads to understand their own account, and one that deleted its own history would leave them unable to see that anything ever happened. |