REST API のエンドポイント一覧


この機能は Ver. 3.3.0 で追加予定の、リリース前の機能です

このページは、アルファ版(Ver. 3.3.0-alpha.1)時点の内容です。正式版までに仕様や設定項目が変わる可能性があります。本番サイトでは使わず、検証環境でお試しください。

コアの REST API(名前空間 acms/v1)のエンドポイントの一覧です。パスは /rest-api/acms/v1 からの相対で、実際には末尾に / を付けて呼びます(例: GET /entries/{id} は GET https://example.com/rest-api/acms/v1/entries/12/)。パラメーターと本文の詳しい形は、GET /openapi.json で取得できる OpenAPI の文書が正です。各リソースの使い方と例は、表の上のリンク先のページで説明します。

  • すべてのエンドポイントで認証(API トークン)が必要です。

  • 「PATCH / PUT」は、送った項目だけを変える PATCH と、全体を置き換える PUT の両方があることを示します。PUT では、書き込める最上位の項目をすべて送ります(足りないと 422 validation_failed、code は required)。

  • GET のエンドポイントは HEAD でも呼べます。

  • 書き込み(POST・PUT・PATCH・DELETE)は、どのエンドポイントでも ?dry_run=1 を付けられます。

  • 作成・更新・削除の対象は、URL のブログに所属するものだけです。上の階層のブログの共通(global)なカテゴリー・モジュール ID などは、読み取りでは見えますが、更新・削除はそのブログの URL から行います。

  • 表にないメソッドで呼ぶと 405 method_not_allowed(Allow ヘッダーに使えるメソッド)、表にないパスは 404 route_not_found です。

認証と仕様

詳しくは REST API を使ってみる(GET /me)と REST API のリクエストとレスポンス(OpenAPI)を参照してください。

メソッド

パス

内容

スコープ

GET

/me

トークンとその持ち主のユーザー・権限を取得

不要(認証のみ)

GET

/openapi.json

OpenAPI 3.1 の文書を取得

不要(認証のみ)

GET

/routes

登録済みのルートの一覧(診断用。URL のブログの管理者だけ)

不要(認証のみ)

エントリー

詳しくは エントリーの取得・作成・更新・削除、エントリーの本文とカスタムフィールドを送る、エントリーの公開・バージョン・承認フロー を参照してください。

メソッド

パス

内容

スコープ

GET

/entries

エントリーの一覧

entries:read

POST

/entries

エントリーを作成

entries:write

GET

/entries/editor-settings

エントリー項目設定(ラベル・必須・上限・既定値など)を取得

entries:read

GET

/entries/{id}

エントリーを取得

entries:read

PATCH / PUT

/entries/{id}

エントリーを更新

entries:write

DELETE

/entries/{id}

エントリーを削除(既定はゴミ箱へ移す)

entries:write

POST

/entries/{id}/publish

エントリーを公開

entries:publish

POST

/entries/{id}/unpublish

エントリーを非公開

entries:publish

POST

/entries/{id}/restore

ゴミ箱のエントリーを戻す

entries:write

POST

/entries/{id}/duplicate

エントリーを複製

entries:write

GET

/entries/{id}/lock

編集ロックの状態を取得

entries:read

POST

/entries/{id}/lock

編集ロックを取得

entries:write

DELETE

/entries/{id}/lock

編集ロックを解除

entries:write

POST

/entries/{id}/preview-links

共有プレビューの URL を発行

entries:write

GET

/entries/{id}/revisions

バージョンの一覧

entries:read

GET

/entries/{id}/revisions/{revisionId}

バージョンを取得

entries:read

POST

/entries/{id}/revisions

新しいバージョンを作成

entries:write

PATCH

/entries/{id}/revisions/{revisionId}

バージョンを上書き

entries:write

POST

/entries/{id}/revisions/{revisionId}/publish

バージョンを公開バージョンにする

entries:publish

POST

/entries/{id}/revisions/{revisionId}/duplicate

作業領域から新しいバージョンを作成(承認依頼)

entries:write

DELETE

/entries/{id}/revisions/{revisionId}

バージョンを削除

entries:write

GET

/entries/{id}/approvals

承認フローの履歴

entries:read

POST

/entries/{id}/approvals

承認フローの操作(依頼・承認・差し戻しなど)

approvals:write

公開・非公開・バージョンの公開は entries:publish が必要です。作成・更新・削除・最終承認でも、公開中のエントリーを変える場合は entries:publish が要ります(「認証と API トークン」のページ)。画像・ファイルなどのユニットは API から書き込めません。メディアは /media で登録してから参照します。

メディア

詳しくは メディアを扱う を参照してください。

メソッド

パス

内容

スコープ

GET

/media

メディアの一覧

media:read

POST

/media

メディアをアップロード(multipart/form-data)

media:write

POST

/media/import

URL のファイルをメディアとして取り込む

media:write

POST

/media/{id}/replace

メディアのファイルを差し替え(multipart/form-data)

media:write

GET

/media/{id}

メディアを取得

media:read

PATCH / PUT

/media/{id}

メディアを更新

media:write

DELETE

/media/{id}

メディアを削除(常に完全に削除)

media:write

POST /media は multipart/form-data で、ファイルを file の項目で送ります。メディアにはゴミ箱が無く、DELETE すると完全に削除されます。

サイトの構成(カテゴリー・ブログ・モジュール ID・タグ・ルール)

詳しくは カテゴリー・ブログ・タグを扱う と モジュール ID・ルール・コンフィグを扱う を参照してください。

メソッド

パス

内容

スコープ

GET

/categories

カテゴリーの一覧

categories:read

GET

/categories/{id}

カテゴリーを取得

categories:read

POST

/categories

カテゴリーを作成

categories:write

PATCH / PUT

/categories/{id}

カテゴリーを更新

categories:write

DELETE

/categories/{id}

カテゴリーを削除

categories:write

GET

/blogs

ブログの一覧

blogs:read

GET

/blogs/{id}

ブログを取得

blogs:read

POST

/blogs

URL のブログの子ブログを作成

blogs:write

PATCH / PUT

/blogs/{id}

URL のブログを更新

blogs:write

DELETE

/blogs/{id}

URL のブログを削除

blogs:write

GET

/modules

モジュール ID の一覧

modules:read

GET

/modules/{id}

モジュール ID を取得

modules:read

POST

/modules

モジュール ID を作成

modules:write

PATCH / PUT

/modules/{id}

モジュール ID を更新

modules:write

POST

/modules/{id}/duplicate

モジュール ID を複製

modules:write

DELETE

/modules/{id}

モジュール ID を削除

modules:write

GET

/tags

タグの一覧

tags:read

GET

/tags/{name}

タグを取得(管理用。非公開のエントリーも数える)

tags:write

PATCH

/tags/{name}

タグの名前を変更

tags:write

DELETE

/tags/{name}

タグを削除

tags:write

GET

/rules

ルールの一覧

rules:read

GET

/rules/{id}

ルールを取得

rules:read

POST

/rules

ルールを作成

rules:write

PATCH / PUT

/rules/{id}

ルールを更新

rules:write

DELETE

/rules/{id}

ルールを削除

rules:write

設定とカスタムフィールドの定義

詳しくは カスタムフィールドの定義を扱う と モジュール ID・ルール・コンフィグを扱う を参照してください。

メソッド

パス

内容

スコープ

GET

/field-definitions

カスタムフィールド定義の一覧

field-definitions:read

GET

/field-sets/{id}

フィールドセットを取得(配下のフィールド定義を含む)

field-definitions:read

GET

/field-definitions/{id}

フィールド定義を取得

field-definitions:read

POST

/field-sets

フィールドセットを作成

field-definitions:write

POST

/field-sets/reorder

フィールドセットを並べ替え

field-definitions:write

PATCH

/field-sets/{id}

フィールドセットを更新

field-definitions:write

DELETE

/field-sets/{id}

フィールドセットを配下の定義ごと削除

field-definitions:write

POST

/field-sets/{id}/fields

フィールドセットにフィールド定義を作成

field-definitions:write

POST

/field-sets/{id}/fields/reorder

フィールド定義を並べ替え

field-definitions:write

PATCH

/field-definitions/{id}

フィールド定義を更新

field-definitions:write

DELETE

/field-definitions/{id}

フィールド定義を削除

field-definitions:write

POST

/field-definitions/{id}/duplicate

フィールド定義を複製

field-definitions:write

POST

/field-definitions/{id}/rename-key

フィールド定義のキーを変更

field-definitions:write

POST

/field-definitions/suppress

テーマ・継承由来の定義を、このブログで使わない(使う)にする

field-definitions:write

GET

/config-sets

コンフィグセットの一覧

config-sets:read

GET

/config-sets/{id}

コンフィグセットを取得

config-sets:read

POST

/config-sets

コンフィグセットを作成

config-sets:write

PATCH / PUT

/config-sets/{id}

コンフィグセットを更新

config-sets:write

DELETE

/config-sets/{id}

未使用のコンフィグセットを削除

config-sets:write

GET

/configs

ブログの設定の一覧

configs:read

GET

/rules/{rid}/configs

ルールの設定の一覧

configs:read

GET

/config-sets/{setid}/configs

コンフィグセットの設定の一覧

configs:read

PATCH

/configs

ブログの設定を更新

configs:write

PATCH

/rules/{rid}/configs

ルールの設定を更新

configs:write

PATCH

/config-sets/{setid}/configs

コンフィグセットの設定を更新

configs:write

設定(コンフィグ)の書き込みは、REST API で扱えるように宣言されたキーだけが対象です。それ以外のキーは 422(unknown_config_key)になります。モジュール ID の設定は、/modules/{id} の config で扱います。

ユーザーと管理用の情報

詳しくは ユーザーと管理用のリソースを扱う を参照してください。リダイレクトは REST API と Hook でリダイレクトを扱う でも説明しています。

メソッド

パス

内容

スコープ

GET

/aliases

エイリアスの一覧

aliases:read

GET

/aliases/{id}

エイリアスを取得

aliases:read

POST

/aliases

エイリアスを作成

aliases:write

PATCH / PUT

/aliases/{id}

エイリアスを更新

aliases:write

DELETE

/aliases/{id}

エイリアスを削除

aliases:write

GET

/forms

フォーム ID の一覧

forms:read

GET

/forms/{id}

フォーム ID を取得

forms:read

GET

/forms/{id}/logs

フォームの投稿ログの一覧

forms:read

POST

/forms

フォーム ID を作成

forms:write

PATCH / PUT

/forms/{id}

フォーム ID を更新

forms:write

POST

/forms/{id}/duplicate

フォーム ID を複製

forms:write

DELETE

/forms/{id}

フォーム ID を削除

forms:write

GET

/users

ユーザーの一覧

users:read

GET

/users/{id}

ユーザーを取得

users:read

POST

/users

ユーザーを作成

users:write

PATCH / PUT

/users/{id}

ユーザーを更新

users:write

DELETE

/users/{id}

ユーザーを削除

users:write

GET

/usergroups

ユーザーグループの一覧

usergroups:read

GET

/usergroups/{id}

ユーザーグループを取得

usergroups:read

POST

/usergroups

ユーザーグループを作成(ルートブログの URL のときだけ)

usergroups:write

PATCH / PUT

/usergroups/{id}

ユーザーグループを更新

usergroups:write

DELETE

/usergroups/{id}

ユーザーグループを削除

usergroups:write

GET

/roles

ロールの一覧

roles:read

GET

/roles/{id}

ロールを取得

roles:read

POST

/roles

ロールを作成

roles:write

PATCH / PUT

/roles/{id}

ロールを更新

roles:write

DELETE

/roles/{id}

ロールを削除

roles:write

GET

/webhooks

Webhook の一覧

webhooks:read

GET

/webhooks/{id}

Webhook を取得

webhooks:read

POST

/webhooks

Webhook を作成

webhooks:write

PATCH / PUT

/webhooks/{id}

Webhook を更新

webhooks:write

DELETE

/webhooks/{id}

Webhook を削除

webhooks:write

GET

/redirects

リダイレクトの一覧(照合する順)

redirects:read

GET

/redirects/{id}

リダイレクトを取得

redirects:read

POST

/redirects

リダイレクトを作成

redirects:write

PATCH / PUT

/redirects/{id}

リダイレクトを更新

redirects:write

DELETE

/redirects/{id}

リダイレクトを削除

redirects:write

POST

/redirects/reorder

リダイレクトを並べ替え

redirects:write

GET

/audit-logs

監査ログの一覧

audit-logs:read

GET

/audit-logs/{id}

監査ログを取得

audit-logs:read

POST

/webhooks/{id}/test

Webhook のテスト送信

webhooks:write

これらの多くは「強い権限」(専用スコープ)が必要です。ユーザー・フォームの投稿ログ・監査ログなどを読んだ記録は、監査ログに残ります。

運用とジョブ

詳しくは 時間のかかる処理をジョブで実行する を参照してください。

メソッド

パス

内容

スコープ

POST

/cache/clear

キャッシュをクリア

cache:write

GET

/jobs/{id}

非同期ジョブの状態を取得

ジョブを始めたトークンだけ

POST

/backups

データベースのバックアップを開始(ジョブ)

backups:write

POST

/exports

WordPress(WXR)形式のエクスポートを開始(ジョブ)

exports:write

POST

/static-exports

静的書き出しを開始(ジョブ)

static-exports:write

POST

/imports

エントリーの CSV インポートを開始(ジョブ。multipart/form-data)

imports:write

POST

/fulltext/rebuild

キーワード検索のテキストの再構築を開始(ジョブ)

fulltext:write

POST

/plugins/activate

プラグインを有効化(ジョブ)

plugins:write

POST

/plugins/deactivate

プラグインを無効化(ジョブ)

plugins:write

ジョブを始めるエンドポイントは、受け付けると 202 を返します。進み具合は Location の URL(GET /jobs/{id})で確かめます(「安全に書き込むための仕組み」のページ)。作ったバックアップやエクスポートのファイルのダウンロード、バックアップの復元は、REST API では行えません。管理画面から行います。

よくある質問・つまずき

表にあるのに 404 route_not_found になります

パスの書き間違い(entrys など)か、名前空間(acms/v1)の抜けを確かめます。プラグインのエンドポイントは、そのプラグインの名前空間(例: mysite/v1)の下にあります。GET /routes(URL のブログの管理者だけ)で、登録済みのルートの一覧を確かめられます。

OPTIONS で呼ぶと 405 になります

REST API は CORS の事前確認(プリフライト)に応えません。OPTIONS は 405 method_not_allowed です。ブラウザの別オリジンから呼ぶ使い方は想定していません。

GET /tags/{name} に tags:write が要るのはなぜですか

単体の取得は管理用で、非公開のエントリーに付いたタグも数えるためです。公開側で見える数だけでよければ、GET /tags(tags:read)を使います。