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

Export/Import of API Schema

Last updated: 2026/09/11

To facilitate the creation of similar APIs in other services, microCMS supports the export and import of API schemas.
By exporting the API schema as a JSON file and importing this JSON file during API creation, you can eliminate the need for manual configuration.

Information

You can also obtain the API schema using the API.
For more details, please refer to the Management API documentation.

Exporting API Schema

First, let’s explain how to export.
Select the content for which you want to export the API schema, then choose "API Settings" → "API Schema".

Next, a button labeled "Export this setting" will appear at the bottom of the screen, so please click it.
You can download the resulting JSON file.

Information

Depending on your permissions, you may not be able to access this screen or perform the import operations listed below.
In such cases, please check the permission management status or contact your service administrator.


Importing API Schema

First, let’s explain how to import.

Start by creating an API from the menu on the left side of the Administration console (①). After entering the basic information and selecting the API type, the screen for "Defining API Schema" will appear. Please select a file from the link "If you are importing a file, click here" (②).

Preparing JSON for Import

The JSON file used for import can be prepared in one of the following ways.

Using an Exported JSON File

You can export an existing API schema and import that JSON file directly. This method is suitable for duplicating schemas to a different project or environment.

Creating and Editing a JSON File Independently (For Developers)

If you want to freely construct a specific field configuration, you can create a JSON file according to the specifications in this document.
Since creating from scratch can easily lead to structural errors, it is recommended to download the JSON below and edit it for use.

Caution
  • Regarding Operation Guarantee: Please be aware that importing JSON that does not comply with the specifications outlined in this document may result in unexpected errors. Additionally, we cannot guarantee the operation of JSON files that are created or edited independently, as well as their import results.
  • Response to Issues: In the unlikely event that abnormalities occur in the display of the Administration console after import, please delete the affected API and recreate it. If you are unable to identify the cause or if it is difficult to address, please contact us via the chat support located at the bottom right of the Administration console.

Basic Structure of JSON Data

The JSON for import consists of two arrays: apiFields for defining fields and customFields for defining custom fields.
Below is an example of JSON data.

{
  "apiFields": [
    {
      "fieldId": "title",
      "name": "Title",
      "kind": "text",
      "description": null,
      "required": false,
      "textSizeLimitValidation": null,
      "patternMatchValidation": null,
      "isUnique": false,
      "initialValue": null
    },
    {
      /* Add subsequent standard fields here */
    }
  ],
  "customFields": [
    {
      "fieldId": "profile",
      "name": "Profile",
      "fieldOrderByColumn": [["name"], ["bio"]],
      "fields": [
        {
          "fieldId": "name",
          "name": "Name",
          "kind": "text",
          "description": null,
          "required": false,
          "textSizeLimitValidation": null,
          "patternMatchValidation": null,
          "isUnique": false,
          "initialValue": null
        },
        {
          "fieldId": "bio",
          "name": "Self Introduction",
          "kind": "textArea",
          "description": null,
          "required": false,
          "textSizeLimitValidation": null,
          "patternMatchValidation": null,
          "initialValue": null
        },
        {
          /* Add subsequent fields within this custom field here */
        }
      ]
    },
    {
      /* Add subsequent custom fields here if defining more */
    }
  ]
}

Field (apiFields) / Custom Field (customFields) Settings

The properties and constraints that can be specified for each field and custom field are generally the same as those for apiFields / customFields specified in the request body of the Management API POST /api/v1/apis.
Please refer to the documentation below for more details.

Field (apiFields)

POST /api/v1/apis
https://document.microcms.io/en/management-api/post-apis#h06802863f3

Custom Fields (customFields)

POST /api/v1/apis
https://document.microcms.io/en/management-api/post-apis#h34957f099a
Information

In the Content Reference and Multiple Content References fields, specify the endpoint of the referenced API in referencedApiEndpoint.
In the Management API's API creation request, specifying the referenced API is mandatory; however, in the import JSON, you can specify null for referencedApiEndpoint to load it.
If you import without specifying the referenced API, please set the referenced API from the Administration console after the import.

Download Sample Data

When building custom fields and repeat fields, it is essential to accurately define the hierarchical data structure. To prevent structural errors from creating from scratch and to facilitate smoother setup, please utilize the following pre-structured sample JSON as a base.

Single-Level Repeat Field

Multi-level (3-layer nested) Repeat Field

Contents

  • Exporting API Schema
  • Importing API Schema
  • Preparing JSON for Import
  • Basic Structure of JSON Data
  • Field (apiFields) / Custom Field (customFields) Settings
  • Download Sample Data
  • Company
  • Legal Notice
  • Terms of Service
  • Privacy Policy

Copyright © microcms.io All rights reserved.