microCMS

POST /api/v1/media

最終更新日:2024年01月24日

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

仕様

  • アップロード可能なメディアの形式は画像のみです。その他のメディア(PDF、動画など)については、管理画面からアップロードしてください。
  • アップロード可能なファイルサイズ上限は5MBまでです。それ以上のサイズの画像については、管理画面からアップロードしてください。
  • 1リクエストにつき、1ファイルのみアップロード可能です。

リクエストヘッダー

X-MICROCMS-API-KEY

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

informationInformation

クライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かればAPIを呼び出せてしまうことにご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。

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=@cat.jpg" https://[サービスID].microcms-management.io/api/v1/media

レスポンス

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

レスポンスボディ

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