microCMS

チュートリアル
操作マニュアル
コンテンツAPI
マネジメントAPI（ベータ）
画像API
  • トップ
  • マネジメントAPI （ベータ）

POST /api/v1/media

最終更新日:2024年05月22日

サービスに画像をアップロードできるAPIです。

仕様

  • アップロード可能なメディアの形式は、画像とファイル（画像以外のメディア）です。
informationInformation

ファイルのアップロードは、Teamプラン、Businessプラン、Advancedプラン、Enterpriseプランでご利用いただける機能です。
プランごとに利用できる機能については、料金プランページをご覧ください。

  • アップロード可能なファイルサイズ上限は5MBまでです。サイズ上限を超える画像やファイルは、管理画面よりアップロードしてください。
  • 1リクエストにつき、1ファイルのみアップロード可能です。

リクエストヘッダー

X-MICROCMS-API-KEY

APIリクエストの際に必要な認証キーです。
マネジメントAPIの権限で「メディアのアップロード」を有効にして、リクエストヘッダーに含めて送信してください。

cautionCaution

X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー（APIの認証と権限管理）」をご覧ください。

Content-Type

送信するデータの形式を指定します。
multipart/form-data; boundary=--[任意の値(boundary)]を指定してください。

リクエストボディ

--[任意の値(boundary)]
Content-Disposition: form-data; name="file"; filename="[ファイル名]"
Content-Type: [ファイルのMIMEタイプ]
[ファイルのバイナリデータ]
--[任意の値(boundary)]

リクエスト例

curlを利用する場合のリクエスト例です。

// 画像
curl -X POST -H 'X-MICROCMS-API-KEY: [APIキー]' -F "file=@sample.jpg" https://[サービスID].microcms-management.io/api/v1/media

// ファイル
curl -X POST -H 'X-MICROCMS-API-KEY: [APIキー]' -F "file=@sample.txt" https://[サービスID].microcms-management.io/api/v1/media

レスポンス

正常に画像を作成できた場合は、201レスポンスが返却されます。

レスポンスボディ

// 画像
{"url":"https://images.microcms-assets.io/assets/xxx/yyy/sample.jpg"}

//ファイル
{"url":"https://files.microcms-assets.io/assets/xxx/yyy/sample.txt"}


目次