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
  • Manual

API Settings

Last updated: 2026/07/06

In the API settings screen, you can change various settings related to the API.
You can access the API settings screen after selecting various APIs from the sidebar.

Basic Information

In the basic information settings screen, you can change the API name and endpoint name.

API Name

This is the name used to identify the API. It is used for display in the management screen.

Endpoint

This is the value included in the URL for calling the API.

Caution
  • If you change the endpoint name and make a call using the old URL, a 404 error will occur. Please ensure that the change will not impact operations before proceeding.

API Schema

In the API Schema screen, you can add fields to the API schema and modify the settings of the created schema.

Caution

After creating a field, the settings can be changed at any time (with some exceptions). However, in such cases, the response from the Content API may change, which could affect the systems you are using. Please be cautious when making changes if you are already in operation.

How to Add a Field

  1. Click the "Add Field" button at the bottom of the field list.
  2. Enter the Field ID, Display Name, and Type (all required).


Field ID

A unique ID for each field. It will be the property name in the API response.

Display Name

This will be displayed when entering content.

Type

Specifies the input form format when entering content.
You can choose from various types such as text fields, rich editors, image fields, and more.

Caution

The type of a field that has been created cannot be changed. If you want to change it, please delete the field first and then create a new one.


Field Detailed Settings

In addition to required input fields, detailed settings can be configured for each field.

Required Fields

By checking this option, you can set the field as "required" when submitting content. This can be set for all fields.

Detailed Settings

Detailed settings can be configured for each field. Click on "Detailed Settings" at the right end of each field to open the settings screen.



Below is an example of a text field.



To reflect the settings in the API schema, close the settings screen by clicking "Close" and then click the "Change" button.

Settings for Each Field

Common Items for All Fields

Required Field

If set to ON, data entry for the field is mandatory.

Description

This is the description displayed at the top of the field in the Administration console.

Default Value

You can set the default value for each field when creating new content. Please check the details page for each field for more information.

Information

When setting default values, please keep the following points in mind:

  • Default values will only apply to newly created contents after they have been set.
  • If you create new content by copying existing content, the default values will not be reflected.
  • Depending on other validation settings, the configured default values may not be usable.

1. Text Field

Text Field
https://document.microcms.io/en/manual/text-field#h4ba8f153e0

2. Text Area

Text Area
https://document.microcms.io/en/manual/textarea#h4ba8f153e0

3. Rich Text Editor

Editing the Toolbar

You can restrict the available buttons in the toolbar.

Color Presets

You can select registered colors when setting the text color. Enabling "Show only color presets and hide the color picker" will allow you to select only the preset colors registered in advance.
For more details on how to use it, please refer to "How to Use the Rich Text Editor".

Text Size Presets

You can select registered text sizes when setting the text size. For more details on how to use it, please refer to "How to Use the Rich Text Editor".

Custom Class

You can assign registered class names to specific text elements. For more details on how to use it, please refer to "How to Use the Rich Text Editor".

Default Values

You can set default values at the time of submission.

4. Old Rich Text Editor (Deprecated)

Decoration Buttons

You can limit the available decoration buttons.

Use
Tag for Line Breaks

If enabled, line breaks will use <br> tags. If disabled, paragraphs will be separated using <p> tags.

Include Width and Height in Image Response

If enabled, the <img> tag will include width and height.

5. Image

Image
https://document.microcms.io/en/manual/image#h4ba8f153e0

6. Multiple Images

Multiple Images
https://document.microcms.io/en/manual/image-list#h4ba8f153e0

7. Date

Date
https://document.microcms.io/en/manual/date#h4ba8f153e0

8. Boolean

Boolean
https://document.microcms.io/en/manual/boolean#h4ba8f153e0

9. Selectable Field

Selectable Field
https://document.microcms.io/en/manual/select-field#h4ba8f153e0

10. Content Reference

Content Reference
https://document.microcms.io/en/manual/relation#h4ba8f153e0

11. Multiple Content References

Multiple Content References
https://document.microcms.io/en/manual/relation-list#h4ba8f153e0

12. Number

Number
https://document.microcms.io/en/manual/number#h4ba8f153e0

13. Custom

Custom
https://document.microcms.io/en/manual/custom-field

14. Repeat

Repetition
https://document.microcms.io/en/manual/repeat-field

15. File

File
https://document.microcms.io/en/manual/file#h4ba8f153e0

16. Extended Field

https://document.microcms.io/en/manual/iframe-field
https://document.microcms.io/en/manual/iframe-field

Custom Status

For information on how to use Custom Status, please refer to the page below.

Custom Status
https://document.microcms.io/en/manual/custom-status

Content ID

For information on setting the Content ID, please refer to the following page.

Setting the Content ID
https://document.microcms.io/en/manual/content-id-setting

Page Preview

For information on how to use the Page Preview, please refer to the following page.

Screen Preview
https://document.microcms.io/en/manual/screen-preview

Webhook

For information on how to use Webhook, please refer to the following page.

Setting Up Webhooks for Content
https://document.microcms.io/en/manual/webhook-setting

API IP Restriction

For information on how to use API IP Restriction, please refer to the following page.

IP Restrictions for APIs
https://document.microcms.io/en/manual/api-ip-restriction

Delete

This feature allows you to delete all contents and APIs.

Caution

Since this is a dangerous operation, please carefully consider the impact before proceeding. Once the deletion operation is performed, it cannot be undone.

Delete All Contents

This will delete all contents that exist in the API.

Please note that you cannot delete all contents if any of the following conditions apply. If you wish to delete, please modify the contents that meet the conditions.

  1. There is at least one content under review
  2. There is at least one content referenced by another API through a "Multiple Content Reference Field"

Delete API

This will delete the API. Once deleted, the corresponding API will no longer be available.

Please note that you cannot delete the API if any of the following conditions apply. If you wish to delete, please modify the contents or fields that meet the conditions.

  1. There is at least one content
  2. It is referenced by another API through a "Multiple Content Reference Field"

Contents

  • Basic Information
  • API Name
  • Endpoint
  • API Schema
  • How to Add a Field
  • Field Detailed Settings
  • Settings for Each Field
  • Custom Status
  • Content ID
  • Page Preview
  • Webhook
  • API IP Restriction
  • Delete
  • Delete All Contents
  • Delete API
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.