API reference
Audit
Searching the audit log.
Generated from the public API contract (OpenAPI). Descriptions in the contract are written in Japanese.
Endpoints
Section titled “Endpoints”| GET | /v1/audit/events |
| GET | /v1/audit/events/{seq} |
| GET | /v1/audit/dead-letters |
| POST | /v1/audit/dead-letters/{id}/retry |
searchAudit
Section titled “searchAudit”GET/v1/audit/events
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
type |
query | string | 前方一致 | |
actor |
query | string | ||
engagement |
query | string | 運営者の委任を通した操作だけに絞る | |
scope |
query | organization | project |
project なら今のプロジェクトだけ | |
since |
query | string | ||
until |
query | string | ||
cursor |
query | string | ||
limit |
query | integer |
Responses
Section titled “Responses”- 200 —
object: 監査の記録(新しい順) - default —
Problem: RFC 9457 Problem Details
getAuditRecord
Section titled “getAuditRecord”GET/v1/audit/events/{seq}
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
seq |
path | integer | yes |
Responses
Section titled “Responses”- 200 —
object: 記録と、R2 に置いた本体(前の記録のハッシュとつないだもの) - default —
Problem: RFC 9457 Problem Details
listDeadLetters
Section titled “listDeadLetters”GET/v1/audit/dead-letters
audit:read が必要。届け直しても処理できなかったイベント(Queues の DLQ から受けたもの)を、受けた新しい順に返す
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit |
query | integer |
Responses
Section titled “Responses”- 200 —
object: 届けられなかったイベント - default —
Problem: RFC 9457 Problem Details
retryDeadLetter
Section titled “retryDeadLetter”POST/v1/audit/dead-letters/{id}/retry
audit:dead-letters.retry が必要。イベントをキューに入れ直す。処理する側は event id で重複を捨てるので、2 回入れ直しても同じ結果になる。再送を使い切って失敗で終えた Agent の実行は、入れ直しても動かない
Parameters
Section titled “Parameters”| Name | In | Type | Required | Description |
|---|---|---|---|---|
id |
path | string | yes | |
Idempotency-Key |
header | string | 副作用を伴う POST ではサーバーが必須にする。SDK は無ければ自動で付けるので、型では省略できる |
Responses
Section titled “Responses”- 200 —
DeadLetter: 入れ直したイベント - default —
Problem: RFC 9457 Problem Details