microCMS

GET /api/v2/media

最終更新日:2023年12月13日

サービスに含まれるメディア情報を取得できるAPIです。

リクエストヘッダー

X-MICROCMS-API-KEY

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

informationInformation

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

レスポンス例

こちらがマネジメントAPIで取得したメディア一覧のレスポンス例です。

{
  "media": [
    {
      "id": "e803c1fa-368d-4087-b937-646db9f6e328",
      "url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/sample1.png",
      "width": 1200,
      "height": 800
    },
    {
      "id": "52d27e9a-5ada-4c22-9fe9-df2dec7ca1fd",
      "url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/d7bcc402720f471f9f36de5eca4057c5/sample2.png",
      "width": 1200,
      "height": 800
    }
  ],
  "totalCount": 2,
   "token": "FGluY2x1ZGVfY29ud...R0cHljVU5KUQ==" // 一部省略
}
informationInformation

tokenについては、初回リクエスト時、続きのメディア情報がない場合もレスポンスに含まれます。

クエリパラメータ

本APIにはパラメータを指定できます。

limit

取得件数を指定します。
デフォルト値は10です。上限値は100です。

informationInformation

初回リクエスト時のみ有効となります(パラメータにtokenを付与した2回目以降のリクエストでは指定できません)。

imageOnly

動画やPDFなどのファイルは除き、画像のみを取得したい場合に指定するパラメータです。
画像のみを取得する場合はtrueを指定してください。
デフォルト値はfalseです。

informationInformation

初回リクエスト時のみ有効となります(パラメータにtokenを付与した2回目以降のリクエストでは指定できません)。

token

前回のリクエストの続きからコンテンツを取得するためのパラメータです。
初回のレスポンスに含まれる token の値を指定してください。

2回目以降のリクエストについて

初回のリクエストで limit および imageOnly パラメータが付与されている場合、明示的に付与せずともそれらの条件が引き継がれます。

informationInformation

tokenの有効期限は15秒です(ただし、15秒を超えた後も一定期間、トークンは有効な場合があります)。

tipsTips

tokenを利用したメディア情報の取得方法については、ヘルプ「【マネジメントAPI】GET /api/v2/mediaのtokenを用いたリクエスト方法」をご覧ください。