GET /api/v1/apis
最終更新日:2025年10月21日
サービス内で作成されたAPIの一覧情報(API名、エンドポイント名、形式)を取得できるAPIです。
リクエストヘッダー
X-MICROCMS-API-KEY
マネジメントAPIのGET APIリクエストの際に必要な認証キーです。
マネジメントAPIのデフォルト権限で「API情報の取得」を有効にして、リクエストヘッダーに含めて送信してください。
Caution
X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー(APIの認証と権限管理)」をご覧ください。
レスポンスボディ
こちらがマネジメントAPIで取得したAPI情報のレスポンス例です。
{
"apis": [
{
"name": "ブログ",
"endpoint": "blogs",
"type": "list"
},
{
"name": "カテゴリ",
"endpoint": "categories",
"type": "list"
},
{
"name": "バナー",
"endpoint": "banner",
"type": "object"
}
]
}
取得したAPIの情報は apis
という配列で返されます。apis
内のオブジェクトには以下の項目が含まれます。
値 | 説明 |
---|---|
| API名が入ります。 |
| エンドポイント名が入ります。 |
| 型が入ります。リスト形式の場合は |