こんにちは！更新情報のお知らせです。

API経由でmicroCMSのメディア（画像・ファイル）を削除できるようになりました。
microCMSにはコンテンツを扱う「コンテンツAPI」と管理画面内の操作を扱う「マネジメントAPI」の2種類のAPIがありますが、今回の変更はマネジメントAPIでご利用いただけます。

この記事では基本的な使い方についてご紹介します。
APIの詳細については、ドキュメントの「DELETE /api/v2/media」をご覧ください。

メディア削除APIについて

新しくサポートするリクエストは DELETE /api/v2/media です。
メディアをどのように削除できるのか、具体的な利用方法を見てみましょう。

利用方法

APIキーに権限を付与する

メディアの削除をAPIから利用するためには、APIキーに新たに権限を付与する必要があります。
管理画面のAPIキー設定より、「メディアの削除」の権限を追加します。

API経由でメディアを削除する

curlコマンドを利用する場合、以下のようなリクエストを送ってください。
（API_KEYとSERVICE_IDはご自身のものに差し替えてください）

curl -X DELETE -H 'X-MICROCMS-API-KEY: <API_KEY>' \
  "https://<SERVICE_ID>.microcms-management.io/api/v2/media?url=https://images.microcms-assets.io/assets/7f8db1ce8c504b42b23d9abefd37c803/1532be0fd7b24d54a7590546e7a188f5/cat.jpg"

url のクエリパラメータにはmicroCMSにアップロードしている画像やファイルのURLを指定します。
メディアの削除に成功するとステータスコード200が返ります。

ユースケース例

例えば、メディア削除APIは以下のようなシーンで便利にお使いいただけます。

大量のメディアを削除したいとき

不要になったメディアを一括削除したい場合、管理画面で操作よりもAPIで簡単に削除できます。

一連のワークフローに、メディアを削除する処理を組み込みたいとき

自社システムとmicroCMSのメディアを連動させていて、自社システム上で削除された場合はmicroCMSからも削除したい場合などに便利です。
APIからアクセス可能になったことで、ワークフローに柔軟に合わせられます。

おわりに

今回はメディア削除のマネジメントAPIについて紹介しました。
より使いやすいサービスを目指してAPI、管理画面ともに改善してまいります。ご要望などございましたら管理画面右下のチャットボタンよりご意見いただけますと幸いです。