サービスに含まれるメディア情報を取得できるAPIです。
2023年12月より、新たにメディア情報を取得するためのエンドポイント（GET api/v2/media）をご提供しています。今後はこちらのご利用を推奨いたします。
既知の不具合として、10,000件より多いメディアを取得する場合（offsetに10,000件以上の値を設定する場合）、正常にデータが取得できない事象を確認しています。
10,000件を超えるメディア情報を取得する場合は、GET /api/v2/media をご利用ください。
GET APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「メディアの取得」を有効にして、リクエストヘッダーに含めて送信してください。
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー（APIの認証と権限管理）」をご覧ください。
こちらがマネジメント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にはパラメータを指定できます。
取得件数を指定します。
デフォルト値は10です。上限値は100です。
コンテンツを取得開始する位置を、指定した値だけ後ろにずらします。
デフォルト値は0です。
動画やPDFなどのファイルは除き、画像のみを取得したい場合に指定するパラメータです。
画像のみを取得する場合はtrueを指定してください。
デフォルト値はfalseです。