microCMS
ドキュメント
  • 料金プラン
  • ブログ
  • よくある質問
  • お問い合わせ
  • ログイン
  • 無料ではじめる
ナビゲーション
チュートリアル
Next.js
  • Next.jsとの連携
  • Getting Started(App Router)
  • チュートリアル(App Router)
  • Getting Started(Pages Router)
  • チュートリアル(Pages Router)
Astro
  • Astroとの連携
  • Getting Started
  • チュートリアル
Nuxt
  • Nuxtとの連携
  • Getting Started
  • チュートリアル
Gatsby
  • Gatsbyとの連携
  • Getting Started
  • チュートリアル
JavaScript
  • JavaScriptとの連携
  • Getting Started(ブラウザ)
  • Getting Started(サーバー)
PHP
  • PHPとの連携
  • Getting Started
Ruby
  • Rubyとの連携
  • Getting Started
Go
  • Goとの連携
  • Getting Started
操作マニュアル
  • はじめに
アカウントとログイン
  • アカウント登録
  • ログイン
  • メールアドレス認証をする
サービス
  • サービスの作成
  • サービス設定
  • テンプレート
  • サービスの削除
お支払い
  • 料金プランの変更
  • 決済方法の登録と変更
API
  • APIの作成・管理
  • API設定
  • APIスキーマのエクスポート/インポート
フィールド
  • テキストフィールド
  • テキストエリア
  • 画像
  • 複数画像
  • 日時
  • 真偽値
  • セレクトフィールド
  • コンテンツ参照
  • 複数コンテンツ参照
  • 数字
  • ファイル
  • カスタム
  • 繰り返し
  • 拡張フィールド
コンテンツ
  • コンテンツの作成
  • コンテンツの編集
  • コンテンツ管理
  • ビュー
  • コンテンツのステータス
  • カスタムステータス
  • コンテンツIDの設定
  • コンテンツに自動付与される値
  • コンテンツのCSVエクスポート
  • コンテンツのCSVインポート
  • APIプレビュー
  • APIプレビューを活用したクエリパラメータの利用例
  • レンダリング方式ごとの組み込み方法
  • 画面プレビュー
  • コンテンツのWebhookを設定
リッチエディタ
  • リッチエディタの操作方法
  • リッチエディタのWRITE API
  • 旧リッチエディタの操作方法
レビュー機能
  • レビュー
  • AIレビュー
メディア
  • メディア管理
  • メディアのフィルター・表示順の変更
  • メディアのタグ設定
  • メディアのWebhookを設定
  • メディアのカスタムドメイン設定
権限管理
  • メンバーの管理
  • ロール(管理画面の権限管理)
複数環境
  • 複数環境(開発環境)
  • 環境間のAPI設定のマージ
外部連携
  • Amazon S3連携
データログ
  • 監査ログ
  • データ転送量
セキュリティ
  • コンテンツの更新履歴
  • 管理画面のIP制限
  • APIのIP制限
認証設定
  • 2要素認証の設定
  • 2要素認証の必須化
  • シングルサインオン
仕様・制限事項
  • 推奨環境
  • 制限事項/注意事項
コンテンツAPI
  • コンテンツAPIとは
基本操作
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
APIキー
  • APIキー(APIの認証と権限管理)
  • 旧API(X-API-KEYなど)からの移行
レスポンスとエラー処理
  • GET APIのフィールドごとのレスポンス形式
  • GET APIにおけるクエリパラメータの指定
  • コンテンツAPIのエラーレスポンス
マネジメントAPI(ベータ)
  • マネジメントAPIとは
コンテンツ操作
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
メディア操作
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
メンバー操作
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API操作
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
  • POST /api/v1/apis
サービス操作
  • GET /api/v1/service
レスポンスとエラー処理
  • マネジメントAPIのエラーレスポンス
画像API
  • 画像APIとは
主なパラメータ
  • 画像サイズ
  • 品質
  • 解像度・画面サイズ
  • フォーマット
  • テキスト
  • 枠線
  • パディング
  • 形状
  • ダウンロード
  • ウォーターマーク
MCPサーバー
  • microCMS MCP
  • microCMS Document MCP Server
  • トップ
  • 操作マニュアル

API設定

最終更新日: 2026/07/06

API設定画面では、APIに関連する各種設定を変更することが可能です。
API設定画面には、サイドバーから各種APIを選択後に、アクセスすることができます。

基本情報

基本情報の設定画面では、API名とエンドポイント名の変更ができます。

API名

APIを識別するための名前です。管理画面での表示に用いられます。

エンドポイント

APIの呼び出し先のURLに含まれる値です。

Caution
  • エンドポイント名を変更した場合、変更前のURLで呼び出しを行った場合は、404エラーとなります。変更を行う際には、運用に影響がないことを十分にご確認ください。

APIスキーマ

APIスキーマ画面では、APIスキーマへのフィールドの追加や、作成したスキーマの設定の変更ができます。

Caution

フィールドの作成後も、設定は任意のタイミングで変更可能です(一部の設定を除く)。ただしその場合、コンテンツAPIのレスポンスが変化し、ご利用先のシステムに影響がある場合があります。すでに運用中の場合の変更にあたっては、ご注意ください。

フィールドの追加方法

  1. フィールドのリスト最下部にある「フィールドを追加」ボタンを押下します。
  2. フィールドID/表示名/種類をそれぞれ入力します(必須)。


フィールドID

フィールドごとの一意なIDです。APIレスポンスのプロパティ名となります。

表示名

コンテンツを入力する際に表示されます。

種類

コンテンツを入力する際の入力フォーム形式を指定します。
テキストフィールド、リッチエディタ、画像フィールドなど様々な種類から選択可能です。

Caution

一度作成したフィールドの種類は変更できません。変更したい場合は一度フィールドを削除し、新たに作成し直してください。


フィールドの詳細設定

必須入力項目以外に、各フィールドにおいて詳細設定が可能です。

必須項目

チェックを入れるとコンテンツ入稿する際に、「必須」の設定にできます。全フィールドで設定可能です。

詳細設定

フィールドごとに詳細設定が可能です。各フィールド右端の「詳細設定」をクリックすると、設定画面が開きます。



以下はテキストフィールドの例です。



APIスキーマ設定に反映させるには、「閉じる」で設定画面を閉じ、「変更する」ボタンをクリックします。

フィールドごとに設定できる項目

全フィールド共通の項目

必須項目

設定がONの場合、フィールドへのデータ入力が必須となります。

説明文

管理画面のフィールドの上部に表示される説明文です。

初期値

コンテンツを新規作成する際の初期値を、フィールドごとに設定できます。詳細は各フィールドの詳細ページをご確認ください。

Information

初期値を設定する際は、以下の点にご留意ください。

  • 初期値を設定した後に新規作成されたコンテンツにのみ適用されます
  • コンテンツをコピーして新規作成した場合、初期値は反映されません
  • 他のバリデーション設定によっては、設定した初期値を利用できない場合があります

1. テキストフィールド

テキストフィールド
https://document.microcms.io/manual/text-field#h4ba8f153e0

2. テキストエリア

テキストエリア
https://document.microcms.io/manual/textarea#h4ba8f153e0

3. リッチエディタ

ツールバーの編集

使用可能なツールバーのボタンを制限することができます。

色のプリセット

登録した色を、文字色の設定の際に選択することができます。「色のプリセットのみを表示し、カラーピッカーを非表示にする」を有効にすると、事前に登録したプリセットカラーのみを選択できるようになります。
利用方法の詳細については、「リッチエディタの操作方法」をご参照ください。

文字サイズのプリセット

登録した文字サイズを、文字サイズの設定の際に選択することができます。利用方法の詳細については、「リッチエディタの操作方法」をご参照ください。

カスタムclass

登録したclass名を特定のテキスト要素に付与できます。利用方法の詳細については、「リッチエディタの操作方法」をご参照ください。

初期値

入稿時の初期値を設定できます。

4. 旧リッチエディタ(非推奨)

装飾ボタン

使用可能な装飾ボタンを制限することができます。

改行に
タグを用いる

オンの場合は<br>タグで改行します。オフの場合は<p>タグで段落分けします。

画像のレスポンスにwidthとheightを含む

オンの場合は <img> タグに width と height が含まれます。

5. 画像

画像
https://document.microcms.io/manual/image#h4ba8f153e0

6. 複数画像

複数画像
https://document.microcms.io/manual/image-list#h4ba8f153e0

7. 日時

日時
https://document.microcms.io/manual/date#h4ba8f153e0

8. 真偽値

真偽値
https://document.microcms.io/manual/boolean#h4ba8f153e0

9. セレクトフィールド

セレクトフィールド
https://document.microcms.io/manual/select-field#h4ba8f153e0

10. コンテンツ参照

コンテンツ参照
https://document.microcms.io/manual/relation#h4ba8f153e0

11. 複数コンテンツ参照

複数コンテンツ参照
https://document.microcms.io/manual/relation-list#h4ba8f153e0

12. 数字

数字
https://document.microcms.io/manual/number#h4ba8f153e0

13. カスタム

カスタム
https://document.microcms.io/manual/custom-field

14. 繰り返し

繰り返し
https://document.microcms.io/manual/repeat-field

15. ファイル

ファイル
https://document.microcms.io/manual/file#h4ba8f153e0

16. 拡張フィールド

拡張フィールド
https://document.microcms.io/manual/iframe-field

カスタムステータス

カスタムステータスのご利用方法については、以下のページをご参照ください。

カスタムステータス
https://document.microcms.io/manual/custom-status

コンテンツID

コンテンツIDの設定については、以下のページをご参照ください。

コンテンツIDの設定
https://document.microcms.io/manual/content-id-setting

画面プレビュー

画面プレビューのご利用方法については、以下のページをご参照ください。

画面プレビュー
https://document.microcms.io/manual/screen-preview

Webhook

Webhookのご利用方法については、以下のページをご参照ください。

コンテンツのWebhookを設定
https://document.microcms.io/manual/webhook-setting

APIのIP制限

APIのIP制限のご利用方法については、以下のページをご参照ください。

APIのIP制限
https://document.microcms.io/manual/api-ip-restriction

削除

全コンテンツとAPIを削除するための機能です。

Caution

危険な操作となるため、実施にあたっては影響を十分にご検討ください。削除操作後の取り消しはできません。

全コンテンツを削除する

APIに存在する全てのコンテンツを削除します。

なお、以下の条件に当てはまる場合は、全コンテンツを削除することはできません。削除したい場合、条件に該当するコンテンツを修正してください。

  1. レビュー申請中のコンテンツが1件以上ある
  2. 他のAPIから「(複数)コンテンツ参照フィールド」で参照されているコンテンツが1件以上ある

APIを削除する

APIを削除します。削除を行うと、該当のAPIは利用ができなくなります。

なお、以下の条件に当てはまる場合は、APIを削除することはできません。削除したい場合、条件に該当するコンテンツやフィールドを修正してください。

  1. コンテンツが1件以上ある
  2. 他のAPIから「(複数)コンテンツ参照フィールド」で参照されている

目次

  • 基本情報
  • API名
  • エンドポイント
  • APIスキーマ
  • フィールドの追加方法
  • フィールドの詳細設定
  • フィールドごとに設定できる項目
  • カスタムステータス
  • コンテンツID
  • 画面プレビュー
  • Webhook
  • APIのIP制限
  • 削除
  • 全コンテンツを削除する
  • APIを削除する
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.