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では、書き込める最上位の項目をすべて送ります(足りないと 422validation_failed、codeはrequired)。GETのエンドポイントはHEADでも呼べます。書き込み(POST・PUT・PATCH・DELETE)は、どのエンドポイントでも
?dry_run=1を付けられます。作成・更新・削除の対象は、URL のブログに所属するものだけです。上の階層のブログの共通(global)なカテゴリー・モジュール ID などは、読み取りでは見えますが、更新・削除はそのブログの URL から行います。
表にないメソッドで呼ぶと 405
method_not_allowed(Allowヘッダーに使えるメソッド)、表にないパスは 404route_not_foundです。
認証と仕様
詳しくは REST API を使ってみる(GET /me)と REST API のリクエストとレスポンス(OpenAPI)を参照してください。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| トークンとその持ち主のユーザー・権限を取得 | 不要(認証のみ) |
|
| OpenAPI 3.1 の文書を取得 | 不要(認証のみ) |
|
| 登録済みのルートの一覧(診断用。URL のブログの管理者だけ) | 不要(認証のみ) |
エントリー
詳しくは エントリーの取得・作成・更新・削除、エントリーの本文とカスタムフィールドを送る、エントリーの公開・バージョン・承認フロー を参照してください。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| エントリーの一覧 |
|
|
| エントリーを作成 |
|
|
| エントリー項目設定(ラベル・必須・上限・既定値など)を取得 |
|
|
| エントリーを取得 |
|
|
| エントリーを更新 |
|
|
| エントリーを削除(既定はゴミ箱へ移す) |
|
|
| エントリーを公開 |
|
|
| エントリーを非公開 |
|
|
| ゴミ箱のエントリーを戻す |
|
|
| エントリーを複製 |
|
|
| 編集ロックの状態を取得 |
|
|
| 編集ロックを取得 |
|
|
| 編集ロックを解除 |
|
|
| 共有プレビューの URL を発行 |
|
|
| バージョンの一覧 |
|
|
| バージョンを取得 |
|
|
| 新しいバージョンを作成 |
|
|
| バージョンを上書き |
|
|
| バージョンを公開バージョンにする |
|
|
| 作業領域から新しいバージョンを作成(承認依頼) |
|
|
| バージョンを削除 |
|
|
| 承認フローの履歴 |
|
|
| 承認フローの操作(依頼・承認・差し戻しなど) |
|
公開・非公開・バージョンの公開は entries:publish が必要です。作成・更新・削除・最終承認でも、公開中のエントリーを変える場合は entries:publish が要ります(「認証と API トークン」のページ)。画像・ファイルなどのユニットは API から書き込めません。メディアは /media で登録してから参照します。
メディア
詳しくは メディアを扱う を参照してください。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| メディアの一覧 |
|
|
| メディアをアップロード(multipart/form-data) |
|
|
| URL のファイルをメディアとして取り込む |
|
|
| メディアのファイルを差し替え(multipart/form-data) |
|
|
| メディアを取得 |
|
|
| メディアを更新 |
|
|
| メディアを削除(常に完全に削除) |
|
POST /media は multipart/form-data で、ファイルを file の項目で送ります。メディアにはゴミ箱が無く、DELETE すると完全に削除されます。
サイトの構成(カテゴリー・ブログ・モジュール ID・タグ・ルール)
詳しくは カテゴリー・ブログ・タグを扱う と モジュール ID・ルール・コンフィグを扱う を参照してください。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| カテゴリーの一覧 |
|
|
| カテゴリーを取得 |
|
|
| カテゴリーを作成 |
|
|
| カテゴリーを更新 |
|
|
| カテゴリーを削除 |
|
|
| ブログの一覧 |
|
|
| ブログを取得 |
|
|
| URL のブログの子ブログを作成 |
|
|
| URL のブログを更新 |
|
|
| URL のブログを削除 |
|
|
| モジュール ID の一覧 |
|
|
| モジュール ID を取得 |
|
|
| モジュール ID を作成 |
|
|
| モジュール ID を更新 |
|
|
| モジュール ID を複製 |
|
|
| モジュール ID を削除 |
|
|
| タグの一覧 |
|
|
| タグを取得(管理用。非公開のエントリーも数える) |
|
|
| タグの名前を変更 |
|
|
| タグを削除 |
|
|
| ルールの一覧 |
|
|
| ルールを取得 |
|
|
| ルールを作成 |
|
|
| ルールを更新 |
|
|
| ルールを削除 |
|
設定とカスタムフィールドの定義
詳しくは カスタムフィールドの定義を扱う と モジュール ID・ルール・コンフィグを扱う を参照してください。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| カスタムフィールド定義の一覧 |
|
|
| フィールドセットを取得(配下のフィールド定義を含む) |
|
|
| フィールド定義を取得 |
|
|
| フィールドセットを作成 |
|
|
| フィールドセットを並べ替え |
|
|
| フィールドセットを更新 |
|
|
| フィールドセットを配下の定義ごと削除 |
|
|
| フィールドセットにフィールド定義を作成 |
|
|
| フィールド定義を並べ替え |
|
|
| フィールド定義を更新 |
|
|
| フィールド定義を削除 |
|
|
| フィールド定義を複製 |
|
|
| フィールド定義のキーを変更 |
|
|
| テーマ・継承由来の定義を、このブログで使わない(使う)にする |
|
|
| コンフィグセットの一覧 |
|
|
| コンフィグセットを取得 |
|
|
| コンフィグセットを作成 |
|
|
| コンフィグセットを更新 |
|
|
| 未使用のコンフィグセットを削除 |
|
|
| ブログの設定の一覧 |
|
|
| ルールの設定の一覧 |
|
|
| コンフィグセットの設定の一覧 |
|
|
| ブログの設定を更新 |
|
|
| ルールの設定を更新 |
|
|
| コンフィグセットの設定を更新 |
|
設定(コンフィグ)の書き込みは、REST API で扱えるように宣言されたキーだけが対象です。それ以外のキーは 422(unknown_config_key)になります。モジュール ID の設定は、/modules/{id} の config で扱います。
ユーザーと管理用の情報
詳しくは ユーザーと管理用のリソースを扱う を参照してください。リダイレクトは REST API と Hook でリダイレクトを扱う でも説明しています。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| エイリアスの一覧 |
|
|
| エイリアスを取得 |
|
|
| エイリアスを作成 |
|
|
| エイリアスを更新 |
|
|
| エイリアスを削除 |
|
|
| フォーム ID の一覧 |
|
|
| フォーム ID を取得 |
|
|
| フォームの投稿ログの一覧 |
|
|
| フォーム ID を作成 |
|
|
| フォーム ID を更新 |
|
|
| フォーム ID を複製 |
|
|
| フォーム ID を削除 |
|
|
| ユーザーの一覧 |
|
|
| ユーザーを取得 |
|
|
| ユーザーを作成 |
|
|
| ユーザーを更新 |
|
|
| ユーザーを削除 |
|
|
| ユーザーグループの一覧 |
|
|
| ユーザーグループを取得 |
|
|
| ユーザーグループを作成(ルートブログの URL のときだけ) |
|
|
| ユーザーグループを更新 |
|
|
| ユーザーグループを削除 |
|
|
| ロールの一覧 |
|
|
| ロールを取得 |
|
|
| ロールを作成 |
|
|
| ロールを更新 |
|
|
| ロールを削除 |
|
|
| Webhook の一覧 |
|
|
| Webhook を取得 |
|
|
| Webhook を作成 |
|
|
| Webhook を更新 |
|
|
| Webhook を削除 |
|
|
| リダイレクトの一覧(照合する順) |
|
|
| リダイレクトを取得 |
|
|
| リダイレクトを作成 |
|
|
| リダイレクトを更新 |
|
|
| リダイレクトを削除 |
|
|
| リダイレクトを並べ替え |
|
|
| 監査ログの一覧 |
|
|
| 監査ログを取得 |
|
|
| Webhook のテスト送信 |
|
これらの多くは「強い権限」(専用スコープ)が必要です。ユーザー・フォームの投稿ログ・監査ログなどを読んだ記録は、監査ログに残ります。
運用とジョブ
詳しくは 時間のかかる処理をジョブで実行する を参照してください。
メソッド | パス | 内容 | スコープ |
|---|---|---|---|
|
| キャッシュをクリア |
|
|
| 非同期ジョブの状態を取得 | ジョブを始めたトークンだけ |
|
| データベースのバックアップを開始(ジョブ) |
|
|
| WordPress(WXR)形式のエクスポートを開始(ジョブ) |
|
|
| 静的書き出しを開始(ジョブ) |
|
|
| エントリーの CSV インポートを開始(ジョブ。multipart/form-data) |
|
|
| キーワード検索のテキストの再構築を開始(ジョブ) |
|
|
| プラグインを有効化(ジョブ) |
|
|
| プラグインを無効化(ジョブ) |
|
ジョブを始めるエンドポイントは、受け付けると 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)を使います。