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}
  • PATCH /api/v1/members/{member_id}
API操作
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
  • POST /api/v1/apis
ロール操作
  • GET /api/v1/roles
  • GET /api/v1/roles/{role_id}
  • POST /api/v1/roles
  • PATCH /api/v1/roles/{role_id}
  • DELETE /api/v1/roles/{role_id}
サービス操作
  • GET /api/v1/service
レスポンスとエラー処理
  • マネジメントAPIのエラーレスポンス
画像API
  • 画像APIとは
主なパラメータ
  • 画像サイズ
  • 品質
  • 解像度・画面サイズ
  • フォーマット
  • テキスト
  • 枠線
  • パディング
  • 形状
  • ダウンロード
  • ウォーターマーク
MCPサーバー
  • microCMS MCP
  • microCMS Document MCP Server
  • トップ
  • コンテンツAPI

旧API(X-API-KEYなど)からの移行

最終更新日: 2026/04/24
Information

このセクションについては、2021年10月22日までに作成されたサービス(APIキー)を対象としています。それ以降にサービスを作成された方は、移行作業を実施する必要はございません。

旧形式APIキー(X-API-KEY、X-WRITE-API-KEY、X-DRAFT-API-KEY)からX-MICROCMS-API-KEYへの移行について解説します。

X-MICROCMS-API-KEYについてはこちらのページをご覧ください。

X-MICROCMS-API-KEYへの移行について

以前は X-API-KEY などのヘッダを使ってリクエストを行う必要がありました。

// 通常のデータ取得
$ curl "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-API-KEY: <旧APIキー>"

// 下書きデータの取得
$ curl "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-API-KEY: <旧APIキー>" \
    -H "X-GLOBAL-DRAFT-KEY: <旧APIキー>"

// データの書き込み
$ curl -X POST "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-WRITE-API-KEY: <旧APIキー>"

仕様変更後、APIキーは X-MICROCMS-API-KEY ヘッダに統一されました。管理画面からAPIキーの設定を行うことによって、下書き取得や書き込みに関する権限管理が行えますので、リクエストヘッダの記載を統一することができます。
https://document.microcms.io/content-api/x-microcms-api-key

移行後のAPIキーの指定方法は、以下のようになります。

$ curl "https://<subdomain>.microcms.io/api/v1/<endpoint>" \
    -H "X-MICROCMS-API-KEY: <旧APIキー>"

SDKを利用している場合は、最新版へのアップデートを行なった上、Readmeに記載の方法にて、APIキーの指定を行ってください。

作成済みのAPIキーの自動移行について

旧形式APIキーでX-API-KEY、X-WRITE-API-KEY、X-DRAFT-API-KEYを作成していた場合、それぞれ3種類のX-MICROCMS-API-KEYが生成されています。
各旧APIキーのデフォルト権限は以下の通りです。

  • X-API-KEY → GETのみON
  • X-WRITE-API-KEY → すべてOFF
  • X-GLOBAL-DRAFT-KEY → GET、下書きの全取得のみON
Information
  • X-GLOBAL-DRAFT-KEYのGET権限については、2023年2月20日に追加で付与されました。
  • HTTPメソッドの設定を行なっていた場合は、個別権限として移行されています。

移行期限について

現時点では、X-API-KEYなどの旧ヘッダも引き続き利用することが可能です。ただし将来的な廃止についても検討しておりますので、可能な限りで移行の実施をお願いします。

目次

  • X-MICROCMS-API-KEYへの移行について
  • 作成済みのAPIキーの自動移行について
  • 移行期限について
  • 運営会社
  • 特定商取引法に基づく表記
  • 利用規約
  • プライバシーポリシー

Copyright © microcms.io All rights reserved.