microCMS

DELETE /api/v1/{endpoint}/{content_id}

最終更新日:2023年07月21日

DELETE APIを用いることで、コンテンツの削除をAPI経由で行うことができます。

informationInformation
  • リスト形式のAPIのみ利用可能です。オブジェクト形式のAPIでは利用できませんので、ご注意ください。

リクエストヘッダー

X-MICROCMS-API-KEY

DELETE APIリクエストの際に必要な認証キーです。
デフォルト権限もしくは個別権限で「DELETE」を有効にして、リクエストヘッダーに含めて送信してください。

informationInformation

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

リクエストボディ

不要です。

レスポンス

正常にコンテンツを削除できた場合は202レスポンスが返却されます。

レスポンスボディ

リクエストを正常に実行できた場合のレスポンスボディは以下のようになります。

Accepted