File tree Expand file tree Collapse file tree 1 file changed +64
-0
lines changed
docs/management-api/GET /api/v1 Expand file tree Collapse file tree 1 file changed +64
-0
lines changed Original file line number Diff line number Diff line change 1+ ---
2+ contentId : get-api-list
3+ directory : management-api
4+ ---
5+
6+ # GET /api/v1/apis
7+
8+ サービス内で作成されたAPIの一覧情報(API名、エンドポイント名、形式)を取得できるAPIです。
9+
10+ リクエストヘッダー
11+ =========
12+
13+ X-MICROCMS-API-KEY
14+ ------------------
15+
16+ マネジメントAPIのGET APIリクエストの際に必要な認証キーです。
17+ マネジメントAPIのデフォルト権限で「API情報の取得」を有効にして、リクエストヘッダーに含めて送信してください。
18+
19+ ![ ] ( https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/053bf98d9397420dac38d79035118d1c/CleanShot%202025-10-20%20at%2009.56.00.png )
20+
21+ X-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「[ APIキー(APIの認証と権限管理)] ( https://document.microcms.io/content-api/x-microcms-api-key ) 」をご覧ください。
22+
23+ レスポンスボディ
24+ ========
25+
26+ こちらがマネジメントAPIで取得したAPI情報のレスポンス例です。
27+
28+ {
29+ "apis": [
30+ {
31+ "name": "ブログ",
32+ "endpoint": "blogs",
33+ "type": "list"
34+ },
35+ {
36+ "name": "カテゴリ",
37+ "endpoint": "categories",
38+ "type": "list"
39+ },
40+ {
41+ "name": "バナー",
42+ "endpoint": "banner",
43+ "type": "object"
44+ }
45+ ]
46+ }
47+
48+ 取得したAPIの情報は ` apis ` という配列で返されます。` apis ` 内のオブジェクトには以下の項目が含まれます。
49+
50+ 値
51+
52+ 説明
53+
54+ ` name `
55+
56+ API名が入ります。
57+
58+ ` endpoint `
59+
60+ エンドポイント名が入ります。
61+
62+ ` type `
63+
64+ 型が入ります。リスト形式の場合は` list ` 、オブジェクト形式の場合は` object ` が入ります。
You can’t perform that action at this time.
0 commit comments