コンテンツにスキップ

Admin API:監査ログ

スペースと環境全体の操作の記録を取得し、CSV で書き出す操作です。共通の決まり(認証、エラーの形、日時)は Admin API のリファレンス にあります。

例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。

操作 メソッドとパス
スペースに属さない監査ログ(環境の管理者だけ) GET /admin/api/audit-logs
スペースに属さない監査ログを CSV で書き出す(環境の管理者だけ) GET /admin/api/audit-logs.csv
スペースの監査ログ GET /admin/api/spaces/{slug}/audit-logs
スペースの監査ログを CSV で書き出す GET /admin/api/spaces/{slug}/audit-logs.csv

スペースに属さない監査ログ(環境の管理者だけ)

Section titled “スペースに属さない監査ログ(環境の管理者だけ)”

スペースに属さない監査ログ(ログイン、ユーザーの操作など)。環境の管理者だけ。

GET /admin/api/audit-logs
  • ログイン:要る(セッションかアクセストークン)

パラメーター:

名前 場所 型 必須 決まり 説明
from クエリ 文字列 期間の始め(時差つきの ISO 8601)。この日時を含む
to クエリ 文字列 期間の終わり(時差つきの ISO 8601)。この日時を含まない
action クエリ 文字列 操作の名前。末尾が . なら前方一致(entry. でエントリーの操作すべて)
actorId クエリ 文字列 主体(ユーザーか API キー)の ID
targetType クエリ 文字列 対象の種類(entry など)
targetId クエリ 文字列 対象の ID
limit クエリ 整数 0 以上
cursor クエリ 文字列

返る値:

状態 本文
200 AuditLogList(application/json)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl "https://<ホスト名>.hakocms.net/admin/api/audit-logs" \
-H "Authorization: Bearer <アクセストークン>"

スペースに属さない監査ログを CSV で書き出す(環境の管理者だけ)

Section titled “スペースに属さない監査ログを CSV で書き出す(環境の管理者だけ)”
GET /admin/api/audit-logs.csv
  • ログイン:要る(セッションかアクセストークン)

パラメーター:

名前 場所 型 必須 決まり 説明
from クエリ 文字列 期間の始め(時差つきの ISO 8601)。この日時を含む
to クエリ 文字列 期間の終わり(時差つきの ISO 8601)。この日時を含まない
action クエリ 文字列 操作の名前。末尾が . なら前方一致(entry. でエントリーの操作すべて)
actorId クエリ 文字列 主体(ユーザーか API キー)の ID
targetType クエリ 文字列 対象の種類(entry など)
targetId クエリ 文字列 対象の ID
limit クエリ 整数 0 以上
cursor クエリ 文字列

返る値:

状態 本文
200 ファイル(text/csv)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl "https://<ホスト名>.hakocms.net/admin/api/audit-logs.csv" \
-H "Authorization: Bearer <アクセストークン>"

スペースの監査ログ。audit_logs.read が要る。

GET /admin/api/spaces/{slug}/audit-logs
  • ログイン:要る(セッションかアクセストークン)

パラメーター:

名前 場所 型 必須 決まり 説明
slug パス 文字列 ○ スペースのスラッグ
from クエリ 文字列 期間の始め(時差つきの ISO 8601)。この日時を含む
to クエリ 文字列 期間の終わり(時差つきの ISO 8601)。この日時を含まない
action クエリ 文字列 操作の名前。末尾が . なら前方一致(entry. でエントリーの操作すべて)
actorId クエリ 文字列 主体(ユーザーか API キー)の ID
targetType クエリ 文字列 対象の種類(entry など)
targetId クエリ 文字列 対象の ID
limit クエリ 整数 0 以上
cursor クエリ 文字列

返る値:

状態 本文
200 AuditLogList(application/json)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/audit-logs" \
-H "Authorization: Bearer <アクセストークン>"

スペースの監査ログを CSV で書き出す

Section titled “スペースの監査ログを CSV で書き出す”
GET /admin/api/spaces/{slug}/audit-logs.csv
  • ログイン:要る(セッションかアクセストークン)

パラメーター:

名前 場所 型 必須 決まり 説明
slug パス 文字列 ○ スペースのスラッグ
from クエリ 文字列 期間の始め(時差つきの ISO 8601)。この日時を含む
to クエリ 文字列 期間の終わり(時差つきの ISO 8601)。この日時を含まない
action クエリ 文字列 操作の名前。末尾が . なら前方一致(entry. でエントリーの操作すべて)
actorId クエリ 文字列 主体(ユーザーか API キー)の ID
targetType クエリ 文字列 対象の種類(entry など)
targetId クエリ 文字列 対象の ID
limit クエリ 整数 0 以上
cursor クエリ 文字列

返る値:

状態 本文
200 ファイル(text/csv)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/audit-logs.csv" \
-H "Authorization: Bearer <アクセストークン>"