Top
Manual

Merging API Settings Between Environments

Last updated: 2026/10/14

The merging of API Settings between environments is a feature that can be used to reflect settings confirmed in development and testing environments to the production environment, or to reflect settings changed in the production environment to development and testing environments.
By comparing the differences in API Settings between environments and selecting the APIs you want to reflect, you can collectively apply the basic information, schema, and custom field settings of the APIs.
Merging supports not only reflecting from a different environment to the production environment but also reflecting from the production environment to a different environment, as well as between different environments.

Information: The merging of API Settings between environments is a feature available in the Business plan and Enterprise plan. For usage conditions by plan, please check the Pricing Plan.

Caution: When you perform a merge, the API Settings of the target will be changed. Depending on the differences, new APIs or fields may be created, modified, or deleted. Please ensure that you thoroughly check the source and target of the merge, as well as the differences, before executing. Data lost due to merging will not be recoverable by our company, even if it was deleted by mistake.

Merge Process

1. Open the Target Environment

Open the environment where you want to reflect the settings and select [Merge API Settings] from the environment settings.
The currently displayed environment will be the target for the merge.

2. Select the Source Environment

Select the source environment for the merge.
Example: Reflecting the settings from the staging environment to the production environment

Source: Staging Environment
Target: Production Environment (this will be the currently displayed environment)

3. Check the Differences

Click the [Check Differences] button to display the APIs with differences between the environments. In the list on the left, you can check the APIs by the type of difference.

APIs to be changed
APIs to be newly created
APIs to be deleted

Selecting an API will display the differences. Please check the following items and check the checkbox for the APIs you want to merge.

Basic information of the API
API Schema
Additions, changes, and deletions of fields
Values before and after changes

Caution: APIs or fields that exist only in the merge destination and not in the merge source may be subject to deletion. For more details, please refer to "When there are APIs or fields that do not exist in the merge source."

4. Confirm the merge content and execute the merge

Click the [Confirm Merge Content] button and check the following for the selected API.

Merge eligibility
- If the referenced API in the Content Reference Field or Multiple Content Reference Field does not exist, or if there is content in the list-type API that is subject to deletion, the merge cannot be executed.
Target API for merging
Processing order
Processes executed for each API
- Additions/changes to basic information
- Additions/changes to schema
- Deletion/recreation of APIs and fields
Additional charges

Once you confirm that there are no issues, click [Execute Merge] at the bottom of the screen.

5. Check the merge results

Once the merge starts, the processing status for each API will be displayed in order of processing. The merge is complete when all processes show "Success" and "Merge Complete" is displayed.
If a process fails, the processing of subsequent APIs will be skipped. Please refer to "Other Notes" for the response method.

Pricing

A new API may be created through merging, and additional charges may apply if the number of APIs exceeds the limit of your contracted Plan.

Before executing the merge, the number of newly created APIs and the associated costs will be displayed.
Actual billing occurs at the time the new API is created.
To avoid unnecessary additional charges, we prioritize the deletion of APIs whenever possible. However, due to constraints such as reference relationships, the number of APIs may temporarily exceed the limit of your contracted Plan. The duration of the excess is usually a few seconds, but it may vary depending on the processing and situation. Even a short-term excess may incur additional charges, which will be reflected in your next billing amount. For more details, please refer to the help site's article on "How will the billing amount be calculated if I change the number of additional members or additional APIs mid-month?".

Required Permissions

In environments created with the multiple environments feature, permission management cannot be used, so the permissions required to execute a merge depend on whether the source and destination include the production environment.
The permissions related to merging are as follows:

Read Permission for the Environment

If you have read permission for an environment in a different environment, you can operate the API of that environment.

API Permissions for the Production Environment

In the production environment, permissions are applied per API.
For the source, read permission for the API is required.
For the destination, read, create, edit, and delete permissions for all APIs are required.

Basically, read permission is required for the source, and permissions for modification operations are required for the destination.

Information: With the role that has read access to the environment set to "Only environments with known URLs," you cannot select the source environment from the list. Therefore, you can only perform merges from the production environment to the currently displayed environment.

Required Permissions by Merge Direction

Merge Direction	Source	Destination
Production environment → Other environment	Read permission for all APIs in the production environment	Read permission for the other environment
Other environment → Production environment	Read permission for the other environment	Read, create, edit, and delete permissions for all APIs
Other environment → Other environment	Read permission for the other environment	Read permission for the other environment

Non-Merged Data and Settings

The merge targets are only API Settings and Custom Field Settings. Content and Media will not be copied from the source during the merge.

Initial Values of Fields

The following fields are subject to field settings merging, but the set initial values will not be merged. The existing fields in the merge destination will retain their initial values. For newly created fields, please set them in the merge destination environment after the merge.

Rich Text Editor
Image
Multiple Images
File
Content Reference
Multiple Content References

Settings Items

The following settings are excluded from the merge.

Content ID Settings
Custom Status
Page Preview Settings
Webhook Settings
API IP Restriction

These settings will not be detected as differences even if they differ between the source and destination, so the settings in the merge destination will remain unchanged. Newly created APIs due to the merge will be in an unconfigured state, so please set them in the merge destination environment as needed.

Notes

Changes That May Result in Deletion and Recreation

Depending on the changes, it may be necessary to delete the target or delete and then recreate it, rather than updating the existing settings in the merge destination.

When Changing the API Endpoint

Changing the API endpoint will be processed as deletion and recreation in the merge destination, rather than updating the existing API.
However, for list-type APIs, if there is content in the API to be deleted, the API cannot be deleted, and the merge cannot be executed.

Caution: The object format API will execute deletion and recreation even if the content exists. In this case, the existing content will be lost.

If the API to be deleted is referenced by other APIs, you need to either include the referencing APIs in the merge target or merge them first. In that case, the content reference fields and multiple content reference fields of the referencing APIs will be deleted and recreated, and the values set in those fields will be removed.
Please check the merge eligibility and notes on the merge confirmation screen.

Tips

Recommended Actions

If it is acceptable for the values of the target content or reference fields to be lost, such as in the early stages of development: Proceed with the merge as is. It will be reflected through deletion and recreation. If there is content in the list-type API, delete the content before executing.
If you want to retain the values of the target content or reference fields in a production environment: Manually change the endpoint of the target API to the same value as the source API before executing the merge. It will be treated as the same API and processed as an update.

Caution: Changing the endpoint of the target API may affect the execution of Webhooks and integrations with sites and external services that utilize the API. Please check the impact before making any changes.

Changing Field ID or Custom Field ID

After creating an environment, fields and custom fields added individually in each environment will not be recognized as the same if their IDs differ between the source and destination. In this case, the destination will process it as deletion and recreation rather than updating the existing field. The content will not be deleted, but the values set in the field will be removed.
However, fields and custom fields that have existed since the creation of the environment will be recognized as the same even if their IDs are changed.
Please check the merge confirmation screen for merge eligibility and important notes.

Tips

Recommended Actions

If it is acceptable for the values of the target fields to be lost, such as in the early stages of development: Proceed with the merge as is. It will be reflected through deletion and recreation.
If you want to retain the values of the target fields in a production environment: Before executing the merge, manually change the target Field ID and Custom Field ID to the same values as the source. They will be treated as the same and processed as an update.

Caution: Changing the Field ID or Custom Field ID of the merge destination may affect the execution of Webhooks and integrations with sites or external services using the API. Please check the impact before making any changes.

APIs or Fields Not Present in the Source

During the merge, the settings of the destination are updated based on the source API settings. Therefore, APIs or fields that exist only in the destination and not in the source will be marked for deletion. For example, fields that were added independently in the destination environment will be deleted because they do not exist in the source.
If there is content set for the APIs or fields marked for deletion, that data may be lost. If you want to keep the APIs or fields in the destination, please check the deletion targets on the difference confirmation screen and exclude the relevant APIs from the merge.

Other Important Notes

There is no undo feature after the merge.
If an API processing fails during the merge, subsequent API processing will be skipped. Changes that were reflected before the failure will not be automatically reverted, so please check the latest differences, reselect the target APIs, and merge again.
If the environment settings are changed after confirming the differences, you may need to re-fetch and verify the latest settings, which could lead to errors.
The period from difference confirmation to merge completion is treated as a single merge. Only one merge can be performed simultaneously on the same destination. If another member is in the middle of a merge, opening the Administration console will not start a new merge, and the current step of that merge will be displayed. Please review the content before proceeding.
Even after the merge process is completed, there may be follow-up processes such as updating the search index. The completion display on the screen and the timing of the follow-up process completion may differ.

Contents

Merge Process
Pricing
Required Permissions
Non-Merged Data and Settings
Notes