microCMS
Documentation
  • Pricing
  • Blog
  • FAQ
  • Contact
  • Sign In
  • Get started for free
Navigation
Tutorial
Next.js
  • Integration with Next.js
  • Getting Started with App Router
  • Tutorial (App Router)
  • Getting Started with Pages Router
  • Tutorial (Pages Router)
Astro
  • Getting Started
  • Integration with Astro
  • Tutorial
Nuxt
  • Integration with Nuxt
  • Getting Started
  • Tutorial
Gatsby
  • Integration with Gatsby
  • Getting Started
  • Tutorial
JavaScript
  • Integration with JavaScript
  • Getting Started (Browser)
  • Getting Started (Server)
PHP
  • Integration with PHP
  • Getting Started
Ruby
  • Integration with Ruby
  • Getting Started
Go
  • Integration with Go
  • Getting Started with microCMS
Manual
  • Introduction
Account & Login
  • Account Registration
  • Login
  • Email Address Authentication
Services
  • Creating a Service
  • Service Configuration
  • Template
  • Service Deletion
Payment
  • Change of Pricing Plan
  • Registering and Changing Payment Methods
API
  • Creating and Managing APIs
  • API Settings
  • Export/Import of API Schema
Fields
  • Text Field
  • Text Area
  • Image
  • Multiple Images
  • Date
  • Boolean
  • Selectable Field
  • Content Reference
  • Multiple Content References
  • Number
  • File
  • Extended Field
  • Repetition
  • Custom
Contents
  • CSV Export of Content
  • Content Creation
  • Content Editing
  • Content Management
  • View
  • Content Status
  • Custom Status
  • Setting the Content ID
  • Automatically Assigned Values for Content
  • CSV Import of Content
  • API Preview
  • Examples of Using Query Parameters with API Preview
  • Integration Methods by Rendering Type
  • Screen Preview
  • Setting Up Webhooks for Content
Rich Editor
  • How to Use the Rich Editor
  • Rich Editor WRITE API
  • How to Use the Old Rich Editor
Reviews
  • Review
  • AI Review
Media
  • Media Management
  • Changing Media Filters and Display Order
  • Media Tag Configuration
  • Setting Up Media Webhooks
  • Custom Domain Settings for Media
Permission Management
  • Member Management
  • Roles (Permission Management in the Admin Panel)
Environments
  • Multiple Environments (Development Environment)
  • Merging API Settings Between Environments
Connection
  • Amazon S3 Integration
Logs
  • Audit Log
  • Data Transfer Volume
Security
  • Content Update History
  • IP Restrictions for Management Dashboard
  • IP Restrictions for APIs
Authentication
  • Setting Up Two-Factor Authentication
  • Mandatory Two-Factor Authentication
  • Single Sign-On
Specifications & Limitations
  • Recommended Environment
  • Limitations / Precautions
Content API
  • What is the Content API?
Basic Operations
  • GET /api/v1/{endpoint}
  • GET /api/v1/{endpoint}/{content_id}
  • POST /api/v1/{endpoint}
  • PUT /api/v1/{endpoint}/{content_id}
  • PATCH /api/v1/{endpoint}/{content_id}
  • DELETE /api/v1/{endpoint}/{content_id}
API Keys
  • API Key (API Authentication and Authorization Management)
  • Migration from the Old API (X-API-KEY, etc.)
Responses & Error Handling
  • Response format for each field in the GET API
  • Specifying Query Parameters in the GET API
  • Error Responses of the Content API
Management API (Beta)
  • POST /api/v1/roles
  • DELETE /api/v1/roles/{role_id}
  • GET /api/v1/roles/{role_id}
  • PATCH /api/v1/roles/{role_id}
  • GET /api/v1/roles
  • What is the Management API?
Content Operations
  • PUT /api/v1/contents/{endpoint}/{content_id}/reservation
  • GET /api/v1/contents/{endpoint}
  • GET /api/v1/contents/{endpoint}/{content_id}
  • PATCH /api/v1/contents/{endpoint}/{content_id}/status
  • PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
Media Operations
  • GET /api/v2/media
  • GET /api/v1/media
  • POST /api/v1/media
  • DELETE /api/v2/media
Member Operations
  • PATCH /api/v1/members/{member_id}
  • GET /api/v1/members
  • GET /api/v1/members/{member_id}
API Operations
  • POST /api/v1/apis
  • GET /api/v1/apis
  • GET /api/v1/apis/{endpoint}
Service Operations
  • GET /api/v1/service
Responses & Error Handling
  • Management API Error Responses
Image API
  • What is the Image API?
Parameters
  • Image Size
  • Quality
  • Resolution and Screen Size
  • Format
  • Text
  • Border
  • Padding
  • Shape
  • Download
  • Watermark
MCP Server
  • microCMS MCP
  • microCMS Document MCP Server
  • Top
  • Management API (Beta)

What is the Management API?

Last updated: 2026/11/17
Information

This feature is currently available in the beta version.

By using the Management API, you can retrieve and manipulate information within the management dashboard via the API. For example, for content, you can obtain the scheduled publication date and change the publication status.

Base URL

https://{SERVICE_ID}.microcms-management.io

Information

The Content API operates on a different domain. Please be aware of this.

Specifications

Using the Management API requires authentication via an API Key.
You can restrict the available operations for an API Key by granting permissions. For more details, please refer to the API Key documentation.

API Key (API Authentication and Authorization Management)
https://document.microcms.io/en/content-api/x-microcms-api-key

Limitations

  • For limitations related to the Management API as a whole, please refer to the limitations documentation.
  • For limitations specific to each API, please refer to their individual pages.

Types of APIs

Services

This is the API related to services.

GET /api/v1/service
https://document.microcms.io/en/management-api/get-service

Content

This is the API related to content.
Unlike the Content API, it allows you to retrieve information that is only viewable within the management screen, such as the creator of the content and its status.

GET /api/v1/contents/{endpoint}
https://document.microcms.io/en/management-api/get-list-contents-management
GET /api/v1/contents/{endpoint}/{content_id}
https://document.microcms.io/en/management-api/get-content
PATCH /api/v1/contents/{endpoint}/{content_id}/status
https://document.microcms.io/en/management-api/patch-contents-status
PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
https://document.microcms.io/en/management-api/patch-contents-created-by
PUT /api/v1/contents/{endpoint}/{content_id}/reservation
https://document.microcms.io/en/management-api/put-contents-reservation

Media

This is the API related to Media (images, files).

https://document.microcms.io/en/management-api/get-media
https://document.microcms.io/en/management-api/get-media
GET /api/v2/media
https://document.microcms.io/en/management-api/get-media-v2
POST /api/v1/media
https://document.microcms.io/en/management-api/post-media
DELETE /api/v2/media
https://document.microcms.io/en/management-api/delete-media-v2

Members

This is the API related to Members.

GET /api/v1/members/{member_id}
https://document.microcms.io/en/management-api/get-member
GET /api/v1/members
https://document.microcms.io/en/management-api/get-members

API

This is the API related to the APIs defined in the Administration console.

GET /api/v1/apis
https://document.microcms.io/en/management-api/get-api-list
GET /api/v1/apis/{endpoint}
https://document.microcms.io/en/management-api/get-api-info
POST /api/v1/apis
https://document.microcms.io/en/management-api/post-apis

Roles

APIs related to roles.

GET /api/v1/roles
https://document.microcms.io/en/management-api/get-roles
GET /api/v1/roles/{role_id}
https://document.microcms.io/en/management-api/get-role
POST /api/v1/roles
https://document.microcms.io/en/management-api/post-roles
PATCH /api/v1/roles/{role_id}
https://document.microcms.io/en/management-api/patch-roles
DELETE /api/v1/roles/{role_id}
https://document.microcms.io/en/management-api/delete-roles

Contents

  • Base URL
  • Specifications
  • Limitations
  • Types of APIs
  • Services
  • Content
  • Media
  • Members
  • API
  • Roles
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.