400 Bad Request

IP address rejected.

The request is coming from an unauthorized IP address. Please check the API IP restriction settings and make the request from an allowed IP address.

400 Bad Request

API is stopped for xxxxxxxx service. Please upgrade your plan.

The API has been stopped due to either limitations during plan downgrade or limitations when using the Hobby plan. Please adjust the number of APIs, content, or members to fit within the current plan limits or upgrade your plan.

400 Bad Request

Invalid request

There are consecutive slashes immediately after the domain in the request URL. (e.g., https://{SERVICE_ID}.microcms.io//api/v1/blogs) Please ensure there is only one slash.

401 Unauthorized

X-MICROCMS-API-KEY header is invalid.

An API key (X-MICROCMS-API-KEY) that does not exist for the service has been specified. Please specify an API key that exists in the API key management list.

404 Not Found

-

The specified API or content does not exist, or the content is in a status that cannot be retrieved (either draft or unpublished). Please check if the specified API or content is correct.

To retrieve draft content, please grant the permission for retrieving all draft content. To retrieve a single draft content, use the "draftKey" parameter.

To retrieve unpublished content, please grant the permission for retrieving all unpublished content.

429 Too Many Requests

Too many requests, please try again later.

You have exceeded the API call limits. Please refer to the help article “What to do when a 429 error is returned in the API response” for solutions.

500 Internal Server Error

-

An unexpected error has occurred on the server side. Please refer to the help article “What to do when a 500 error is returned in the API” for solutions.

502 Bad Gateway

-

An unexpected error has occurred on the server side. Please refer to the help article “What to do when a 500 error is returned in the API” for solutions.

503 Service Unavailable

-

An unexpected error has occurred on the server side. Please refer to the help article “What to do when a 500 error is returned in the API” for solutions.

504 Gateway Timeout

-

The request has timed out during processing. Please refer to the help article “What to do when a 500 error is returned in the API” for solutions.

400 Bad Request

GET is forbidden.

GET operation is not allowed. Please check if the GET permission is granted in the API key settings.

400 Bad Request

Invalid 'limit' value.

An invalid value is specified for the query parameter "limit". Please specify a number between 0 and 100.

400 Bad Request

Invalid 'offset' value.

An invalid value is specified for the query parameter "offset". Please specify a number greater than or equal to 0.

400 Bad Request

invalid parameter.

An invalid value is specified for the query parameter. Please check the specification of the query parameters and provide the correct values.

How to specify GET /api/v1/{endpoint}
How to specify GET /api/v1/{endpoint}/{content_id}

400 Bad Request

Response body size is too long. Check your url parameters.

The response size exceeds the limit (approximately 5MB). Please retrieve in parts or retrieve only specific field information.

414 Request-URI Too Large

-

The request URL exceeds the maximum length limit (8KB). Please shorten the request URL.

400 Bad Request

POST is forbidden.

POST operation is not allowed. Please check if the POST permission is granted in the API key settings.

400 Bad Request

Syntax error.

The request body is not in the correct JSON format. Please check the JSON syntax and specify it in the correct format.

400 Bad Request

Status parameter is not available in the current plan. Please upgrade your plan.

The “status” parameter cannot be specified in the current plan. Please upgrade your plan or remove the specification of the “status” parameter.

400 Bad Request

Request body is empty.

The request body is empty. Please prepare the JSON of the content you want to register and specify it as a string in the request body.

400 Bad Request

Please include one or more user-defined fields.

No user-defined fields are specified in the request body. (Only automatically granted fields are specified.) Please specify the defined fields.

400 Bad Request

‘{fieldId}’ is unexpected key.

“{fieldId}” cannot be specified as it is not defined in the API schema. Also, “revisedAt”, “createdAt”, and “updatedAt” are automatically granted values and cannot be specified. Please remove it from the request body.

400 Bad Request

‘{fieldId}’ has unexpected data type.

The value specified for “{fieldId}” does not match the data type defined in the API schema. Please specify a value that matches the data type defined in the schema.

400 Bad Request

‘publishedAt’ field error. This field is valid for content that is meant to be published.

“publishedAt” can only be specified for content that is published. Please remove the specification of “publishedAt” or remove the specification of the “status” parameter.

400 Bad Request

‘{fieldId}’ field error. Please fix date format.

The date format specified for “{fieldId}” is incorrect. Please specify it as a string in ISO format (ISO 8601).

400 Bad Request

‘{fieldId}’ field required error.

“{fieldId}” is a required field. Please include it in the request body.

400 Bad Request

Please input unique value on ‘{fieldId}’ field.

The value specified for “{fieldId}” is already registered in another content. Please specify a unique value that does not duplicate with other contents.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not fit the specified format.

The value specified for “{fieldId}” does not match the regular expression set in the API schema. Please specify a value that matches the set regular expression.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not meet the number of characters allowed.

The value specified for “{fieldId}” does not meet the minimum or exceeds the maximum number of characters set in the API schema. Please check the allowable number of characters and specify an appropriate value.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not in the range.

The value specified for “{fieldId}” does not meet the minimum or exceeds the maximum number of values set in the API schema. Please check the allowable number of values and specify an appropriate value.

400 Bad Request

‘{fieldId}’ field invalid. The value sent exceeds the upper or lower limit.

The value specified for “{fieldId}” does not meet the lower limit (-9007199254740991) or exceeds the upper limit (9007199254740991) set by microCMS. Please specify a value that can be input.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid URL.

The value specified for “{fieldId}” is not a valid URL. Please specify the URL of the image or file uploaded to the media.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid file URL.

The value specified for “{fieldId}” is not a valid file URL. Please ensure that the specified file URL is in the correct format.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid image URL.

The value specified for “{fieldId}” is not a valid image URL. Please ensure that the specified image URL is in the correct format.

400 Bad Request

‘{fieldId}’ field invalid. The image width must be {width} px.

The image specified for “{fieldId}” exceeds the image size limit (width). Please specify an image smaller than the size set in the image size limit.

400 Bad Request

‘{fieldId}’ field invalid. Cannot use this image because its width is unknown.

The image specified for “{fieldId}” cannot be registered because its width cannot be obtained. If there is a size limit set for the image, this error will occur. Please change it to another format such as .jpg, .png, or .webp.

400 Bad Request

‘{fieldId}’ field invalid. The image width must be {height} px.

The image specified for “{fieldId}” exceeds the image size limit (height). Please specify an image smaller than the size set in the image size limit.

400 Bad Request

‘{fieldId}’ field invalid. Cannot use this image because its height is unknown.

The image specified for “{fieldId}” cannot be registered because its height cannot be obtained. If there is a size limit set for the image, this error will occur. Please change it to another format such as .jpg, .png, or .webp.

400 Bad Request

The amount of data that can be saved has been exceeded. Please adjust the contents and try again.

The limit on the amount of data that can be saved (approximately 200KB) has been exceeded. Please refer to the help article “What should I do if I see an error indicating that the content limit has been exceeded?” for solutions.

429 Too Many Requests

Too many contents. Please upgrade your plan.

The limit on the number of contents has been exceeded. Please adjust the number of contents to fit within the default value of your current plan or upgrade your plan.

400 Bad Request

PUT is forbidden.

PUT operation is not allowed. Please check if the PUT permission is granted in the API key settings.

400 Bad Request

Syntax error.

The request body is not in valid JSON format. Please check the JSON syntax and specify it in the correct format.

400 Bad Request

Status parameter is not available in the current plan. Please upgrade your plan.

The current plan does not allow specifying the "status" parameter. Please upgrade your plan or remove the "status" parameter.

400 Bad Request

Request body is empty.

The request body is empty. Please prepare the JSON of the content you want to register and specify it as a string in the request body.

400 Bad Request

contentId is necessary.

The content ID is not specified. Please include the content ID in the request URL.

400 Bad Request

Content is already exists. If you want update, please use PATCH request.

The specified content ID is already in use by another content. Please change the content ID. If you want to update the existing content, please use the PATCH method.

400 Bad Request

Please include one or more user-defined fields.

No user-defined fields are specified in the request body. (Only automatically granted fields are specified.) Please include the defined fields.

400 Bad Request

Invalid content id.

An invalid value is specified for the content ID. Please change the content ID.

400 Bad Request

Invalid content id format.

The format of the specified content ID is incorrect. Please check the content ID settings and specify it in the correct format.

400 Bad Request

‘{fieldId}’ is unexpected key.

“{fieldId}” cannot be specified as it is not defined in the API schema. Additionally, “revisedAt”, “createdAt”, and “updatedAt” are automatically granted values and cannot be specified. Please remove them from the request body.

400 Bad Request

‘{fieldId}’ has unexpected data type.

The value specified for “{fieldId}” does not match the data type defined in the API schema. Please specify a value that matches the data type defined in the schema.

400 Bad Request

‘publishedAt’ field error. This field is valid for content that is meant to be published.

“publishedAt” can only be specified for published content. Please remove the specification of “publishedAt” or remove the specification of the "status" parameter.

400 Bad Request

‘{fieldId}’ field error. Please fix date format.

The date format specified for “{fieldId}” is incorrect. Please specify it as an ISO format (ISO 8601) string.

400 Bad Request

‘{fieldId}’ field required error.

“{fieldId}” is a required field. Please include it in the request body.

400 Bad Request

Please input unique value on ‘{fieldId}’ field.

The value specified for “{fieldId}” is already registered in another content. Please specify a unique value that does not duplicate other contents.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not fit the specified format.

The value specified for “{fieldId}” does not match the regular expression set in the API schema. Please specify a value that matches the set regular expression.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not meet the number of characters allowed.

The value specified for “{fieldId}” does not meet the minimum or exceeds the maximum number of characters set in the API schema. Please check the allowable number of characters and specify an appropriate value.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not in the range.

The value specified for “{fieldId}” does not meet the minimum or exceeds the maximum number set in the API schema. Please check the allowable range and specify an appropriate value.

400 Bad Request

‘{fieldId}’ field invalid. The value sent exceeds the upper or lower limit.

The value specified for “{fieldId}” does not meet the lower limit (-9007199254740991) or exceeds the upper limit (9007199254740991) set by microCMS. Please specify a value that can be input.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid URL.

The value specified for “{fieldId}” is not a valid URL. Please specify the URL of the image or file uploaded to the media.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid file URL.

The value specified for “{fieldId}” is not a valid file URL. Please ensure that the specified file URL is in the correct format.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid image URL.

The value specified for “{fieldId}” is not a valid image URL. Please ensure that the specified image URL is in the correct format.

400 Bad Request

‘{fieldId}’ field invalid. The image width must be {width} px.

The image specified for “{fieldId}” exceeds the image size limit (width). Please specify an image smaller than the size set in the image size limit.

400 Bad Request

‘{fieldId}’ field invalid. Cannot use this image because its width is unknown.

The image specified for “{fieldId}” cannot be registered because its width cannot be obtained. This error occurs if there is a size limit set for the image. Please change it to another format such as .jpg, .png, or .webp.

400 Bad Request

‘{fieldId}’ field invalid. The image width must be {height} px.

The image specified for “{fieldId}” exceeds the image size limit (height). Please specify an image smaller than the size set in the image size limit.

400 Bad Request

‘{fieldId}’ field invalid. Cannot use this image because its height is unknown.

The image specified for “{fieldId}” cannot be registered because its height cannot be obtained. This error occurs if there is a size limit set for the image. Please change it to another format such as .jpg, .png, or .webp.

400 Bad Request

The amount of data that can be saved has been exceeded. Please adjust the contents and try again.

The limit on the amount of data that can be saved (approximately 200KB) has been exceeded. Please refer to the help article "What should I do if I see an error indicating that the content size limit has been exceeded?" for solutions.

429 Too Many Requests

Too many contents. Please upgrade your plan.

You have exceeded the limit on the number of contents. Please adjust the number of contents to fit within the default value of your current plan or upgrade your plan.

400 Bad Request

PATCH is forbidden.

The PATCH operation is not allowed. Please check if the PATCH permission is granted in the API key settings.

400 Bad Request

Syntax error.

The request body is not in the correct JSON format. Please check the JSON syntax and specify it in the correct format.

400 Bad Request

Content is not exists.

The specified content does not exist. Please check if the correct content ID is specified.

400 Bad Request

Request body is empty.

The request body is empty. Please prepare the JSON of the content you want to register and specify it as a string in the request body.

400 Bad Request

‘{fieldId}’ is unexpected key.

“{fieldId}” cannot be specified because it is not defined in the API schema. Also, “revisedAt”, “createdAt”, and “updatedAt” are automatically assigned values and cannot be specified. Please remove them from the request body.

400 Bad Request

‘{fieldId}’ has unexpected data type.

The value specified for “{fieldId}” does not match the data type defined for the field in the API schema. Please specify a value that matches the data type defined in the schema.

400 Bad Request

‘publishedAt’ field error. This field is valid for content that is meant to be published.

“publishedAt” can only be specified for published content. Please remove the specification of “publishedAt”.

400 Bad Request

‘{fieldId}’ field error. Please fix date format.

The date format specified for “{fieldId}” is incorrect. Please specify it as a string in ISO format (ISO 8601).

400 Bad Request

Please input unique value on ‘{fieldId}’ field.

The value specified for “{fieldId}” is already registered in another content. Please specify a unique value that does not duplicate other contents.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not fit the specified format.

The value specified for “{fieldId}” does not match the regular expression set in the API schema. Please specify a value that matches the set regular expression.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not meet the number of characters allowed.

The value specified for “{fieldId}” does not meet the minimum or exceeds the maximum number of characters set in the API schema. Please check the allowable number of characters and specify an appropriate value.

400 Bad Request

‘{fieldId}’ field invalid. The value sent does not in the range.

The value specified for “{fieldId}” does not meet the minimum or exceeds the maximum number of values set in the API schema. Please check the allowable number of values and specify an appropriate value.

400 Bad Request

‘{fieldId}’ field invalid. The value sent exceeds the upper or lower limit.

The value specified for “{fieldId}” does not meet the lower limit (-9007199254740991) or exceeds the upper limit (9007199254740991) set by microCMS. Please specify a value that can be input.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid URL.

The value specified for “{fieldId}” is not a valid URL. Please specify the URL of the image or file uploaded to the media.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid file URL.

The value specified for “{fieldId}” is not a valid file URL. Please ensure that the specified file URL is in the correct format.

400 Bad Request

‘{fieldId}’ field invalid. Please set a valid image URL.

The value specified for “{fieldId}” is not a valid image URL. Please ensure that the specified image URL is in the correct format.

400 Bad Request

‘{fieldId}’ field invalid. The image width must be {width} px.

The image specified for “{fieldId}” exceeds the image size limit (width). Please specify an image smaller than the value set in the image size limit.

400 Bad Request

‘{fieldId}’ field invalid. Cannot use this image because its width is unknown.

The image specified for “{fieldId}” cannot be registered because its width cannot be obtained. If there is a size limit set for the image, this error will occur. Please change it to another format such as .jpg, .png, or .webp.

400 Bad Request

‘{fieldId}’ field invalid. The image width must be {height} px.

The image specified for “{fieldId}” exceeds the image size limit (height). Please specify an image smaller than the value set in the image size limit.

400 Bad Request

‘{fieldId}’ field invalid. Cannot use this image because its height is unknown.

The image specified for “{fieldId}” cannot be registered because its height cannot be obtained. If there is a size limit set for the image, this error will occur. Please change it to another format such as .jpg, .png, or .webp.

400 Bad Request

The amount of data that can be saved has been exceeded. Please adjust the contents and try again.

The limit on the amount of data that can be saved (approximately 200KB) has been exceeded. Please refer to the help article “What should I do if I see an error indicating that the content limit has been exceeded?” for solutions.

400 Bad Request

The status cannot be changed because it is closed.

Content that has ended publication cannot have its status updated via the API. Please update it from the management screen.

400 Bad Request

DELETE is forbidden.

The DELETE operation is not allowed. Please check if the DELETE permission is granted in the API key settings.

400 Bad Request

Content does not exist.

The specified content does not exist. Please verify that the correct content ID is specified.

400 Bad Request

The content is referenced.

The content cannot be deleted because it is referenced by other content. Please remove the reference to the content from the referring content.