This is an API that allows you to retrieve a list of APIs created within the service (API name, endpoint name, format).
This is the authentication key required for GET API requests to the Management API.
Please enable "Retrieve API Information" with the default permissions of the Management API and include it in the request header when sending.
If the X-MICROCMS-API-KEY is identifiable, it may allow unauthorized manipulation of content by third parties. Please handle it with care. For more details, please refer to "API Key (API Authentication and Authorization Management)".
This is an example of the response obtained from the Management API.
{
"apis": [
{
"name": "Blog",
"endpoint": "blogs",
"type": "list"
},
{
"name": "Category",
"endpoint": "categories",
"type": "list"
},
{
"name": "Banner",
"endpoint": "banner",
"type": "object"
}
]
}The information obtained from the API is returned as an array called apis. The objects within apis contain the following items.
Value | Description |
|---|---|
| The API name. |
| The endpoint name. |
| The type. Use |