microCMS

Tutorial
Next.js
Nuxt 3
Nuxt 2
Gatsby
Astro
Remix
JavaScript
PHP
Ruby
Go
iOS
Android
Manual
Account & Login
Services
Payment
API
Fields
Contents
Rich Editor
Reviews
Media
Permission Management
Connection
Logs
Security
Authentication
Specifications & Limitations
Content API
Basic Operations
API Keys
Responses & Error Handling
Management API (Beta)
Content Operations
Media Operations
Member Operations
API Operations
Service Operations
Responses & Error Handling
Image API
Parameters
MCP Server

API Settings

Last updated: 2026/04/24

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.

cautionCaution
  • 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.

cautionCaution

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.

cautionCaution

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 Available for Each Field

Common Items for All Fields

Required Items

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 management screen.

3. Rich Editor

Editing the Toolbar

You can restrict the available buttons on 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 pre-registered preset colors.
For more details on how to use it, please refer to "How to Use the Rich 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 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 Editor".

4. Legacy Rich Editor (Deprecated)

Decoration Buttons

You can limit the available decoration buttons.

Use <br> 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 attributes.

Custom Status

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

Content ID

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

Screen Preview

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

Webhook

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

API IP Restrictions

For information on how to use API IP restrictions, please refer to the page below.

Delete

This is a feature to delete all content and APIs.

cautionCaution

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

Delete All Content

This will delete all content that exists in the API.

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

  1. There is one or more content items under review
  2. There is one or more content items referenced by "multiple content reference fields" from other APIs

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 content or fields that meet the conditions.

  1. There is one or more content items
  2. It is referenced by "multiple content reference fields" from other APIs

Contents