Admin API のリファレンス

Admin API は、管理画面が使っている API です。コンテンツタイプやエントリー、API キー、メンバー、Webhook など、管理画面でできることを、スクリプトや CI から行えます。このページには、すべての操作に共通の決まりと、操作の一覧があります。

サイトにエントリーを表示するときは、Admin API ではなく Content API を使います（Content API のリファレンス）。

ベース URL

https://<ホスト名>.hakocms.net/admin/api

<ホスト名> は、あなたの環境のホスト名です。管理画面のアドレス https://<ホスト名>.hakocms.net/admin と同じです。

認証

スクリプトからは、アクセストークンを Authorization: Bearer で送ります。

curl https://<ホスト名>.hakocms.net/admin/api/me \
  -H "Authorization: Bearer <アクセストークン>"

<アクセストークン> は、hako_pat_ で始まるアクセストークンに置き換えます。

項目	内容
作り方	管理画面の右上のあなたの名前を押し、［アクセストークン］を押して作ります
権限	作った人と同じ権限で動きます
できること	［読み取りだけ］（`GET` だけ）か、［すべて（あなたと同じ）］
期限	30 日、90 日、1 年、無期限から選びます。既定は 90 日です
表示	作ったときに 1 度だけ表示されます
できない操作	アクセストークンを作ること、CLI のログインを許可すること。どちらも管理画面にログインして行います

アクセストークンは、Content API の API キー（hako_ で始まるもの）とは別のものです。API キーでは Admin API を呼べません。

期限のあるトークンで呼ぶと、応答の Hako-Token-Expires-At ヘッダーに期限が入ります。期限を過ぎたトークンや、取り消したトークンで呼ぶと、401 と invalid or expired access token が返ります。

リクエストの形

本文は JSON で送り、Content-Type: application/json を付けます。付けないと 415 が返ります
JSON のキーは camelCase です
パスの {slug} はスペースのスラッグ、{endpoint} はコンテンツタイプ ID（画面の［エンドポイント］）です
日時は UTC の RFC 3339 で返ります（2026-10-08T03:22:22.076Z）

エラーの形

うまくいかなかったときは、4xx か 5xx の状態と、次の形の JSON が返ります。

{ "message": "slug already exists" }

入力が決まりに合わないときは、どこが違うかの一覧 issues も付きます。

{
  "message": "fields.id: fieldId is reserved",
  "issues": [{ "path": "fields.id", "message": "fieldId is reserved" }]
}

状態ごとの意味と直し方は、エラーの一覧にあります。

版と互換性

応答の Hako-Version ヘッダーに、API の版（今は 1）が入ります
同じ版の中では、操作や項目を足すだけにします。操作や項目を消したり、名前や意味を変えたりはしません
形を変えるときは、更新履歴で知らせます
「ベータ」の印がある操作は、この約束の外です。同じ版の中でも形が変わることがあります

操作の一覧

分け	内容	操作の数
ログインとアクセストークン	ログイン、ログアウト、ログイン中のユーザーの取得と、アクセストークンの作成・一覧・取り消しの操作です。	9
パスワードの再設定	パスワードを決め直すためのメールを送る操作です。	1
パスワードを決めるリンク	メールで届いたリンクの中身を確かめ、パスワードを決める操作です。	2
CLI のログインの許可	CLI からのログインを、管理画面で許可・拒否する操作です。	3
ユーザー	環境のユーザーを作る、一覧にする、削除する操作です。環境の管理者だけが使えます。	5
スペース	スペースを作る、取得する、削除する操作です。	4
使用量	スペースと環境全体の、今の使用量と上限を取得する操作です。	2
コンテンツタイプ	コンテンツタイプを作る、変える、削除する操作と、スキーマの更新の操作です。	7
型の定義のダウンロード	スペースのコンテンツタイプから作った OpenAPI、TypeScript の型、GraphQL のスキーマ、スキーマのファイルを取得する操作です。	4
エントリー	管理画面と同じように、エントリーを作る、変える、公開する、削除する操作と、版の履歴の操作です。	11
メディア	メディアをアップロードする、一覧にする、変える、削除する操作です。	6
API キー	Content API で使う API キーを発行する、権限を変える、失効させる操作です。	5
メンバー	スペースのメンバーの一覧、ロールの変更、外す操作です。	4
ロール	スペースのロールを作る、変える、削除する操作です。	5
招待	スペースに人を招待する、招待を取り消す、招待を受け入れる操作です。	5
Webhook	Webhook を作る、変える、削除する操作と、テストの送信、送信履歴、再送の操作です。	8
監査ログ	スペースと環境全体の操作の記録を取得し、CSV で書き出す操作です。	4
スペースの書き出し	スペースの中身を 1 つのファイルに書き出す操作です。	5
スペースの取り込み	書き出したファイルを、新しいスペースとして取り込む操作です。	13
スキーマの反映	スキーマのファイルを、今のスペースに反映する操作です。	5

データの形（型）は Admin API の型にまとめてあります。