GET /api/v1/media

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

リクエストヘッダー

X-MICROCMS-API-KEY

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

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

レスポンス例

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

{
  "media": [
    {
      "id": "e803c1fa-368d-4087-b937-646db9f6e328",
      "url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/test.png",
      "width": 591,
      "height": 138
    },
    {
      "id": "52d27e9a-5ada-4c22-9fe9-df2dec7ca1fd",
      "url": "https://images.microcms-assets.io/assets/9895824867684c2994e22452171b8c11/d7bcc402720f471f9f36de5eca4057c5/example.png",
      "width": 808,
      "height": 177
    }
  ],
  "totalCount": 8,
  "limit": 2,
  "offset": 0
}

クエリストリング

本APIにはクエリストリングを指定できます。

limit

取得件数を指定します。
デフォルト値は10です。
上限値はありませんが、レスポンスサイズ（レスポンスヘッダのcontent-lengthの値）が約5MBを超えるとエラーが発生します。
そのため、大量のコンテンツの全件取得をしたい場合は下記のoffsetパラメータと組み合わせてページング処理を行ってください。

offset

何件目から取得するかを指定します。
デフォルト値は0です。

imageOnly

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