microCMS

Management API Error Responses

This document summarizes the errors that occur when making requests to the Management API, categorized by type.

cautionCaution
  • The information provided below does not guarantee coverage of all status codes during errors. Unexpected issues or omissions may lead to other errors occurring. Please be aware of this in advance.

Response Body on Error

The error response from the Management API may include a message in the response body as follows:

{
    message: "some message"
}


cautionCaution
  • Error messages may change without notice. Please be careful not to handle based on the error messages.

Status Code

Error Message

Cause and Solution

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.

403 Forbidden

Forbidden

Operations via the Management API are not permitted. Please check if the API key is correctly set and if permissions are granted in the API key settings.

404 Not Found

Not Found

The requested URL is incorrect. Please check for any typos in the URL.

429 Too Many Requests

Too Many Requests

You have exceeded the API call limit.

500 Internal Server Error

Internal Server Error

An unexpected error has occurred on the server side.

Status Code

Error Message

Cause and Solution

400 Bad Request

Limit: must be no less than 0.

The limit parameter has a value less than 0. Please specify a number between 0 and 100.

400 Bad Request

limit must be less than or equal to 100

The limit parameter has a value greater than 100. Please specify a number between 0 and 100.

400 Bad Request

Invalid integer in query (limit=xxx)

The limit parameter has an invalid value. Please specify a number between 0 and 100.

400 Bad Request

Offset: must be no less than 0

The offset parameter has a value less than 0. Please specify a non-negative number.

400 Bad Request

Invalid integer in query (offset=xxx)

The offset parameter has an invalid value. Please specify a non-negative number.

404 Not Found

Content not found

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

Status Code

Error Message

Cause and Solution

400 Bad Request

Status: (0: must be a valid value.).

An invalid value is specified in the body. Please check the content of the body.

400 Bad Request

Status: the length must be exactly 1.

An invalid value is specified in the body. Please check the content of the body.

400 Bad Request

invalid user id

An invalid user ID is specified in the body. Please specify an existing user ID.

400 Bad Request

Request body is not JSON object.

The JSON format specified in the body is incorrect. Please check the content of the body.

405 Method Not Allowed

Method Not Allowed

This is a request with a method that is not allowed. Please check if the URL is correct.

Status Code

Error Message

Cause and Solution

400 Bad Request

Limit: must be no less than 0.

The limit parameter has a value less than 0. Please specify a number between 0 and 100.

400 Bad Request

limit must be less than or equal to 100

The limit parameter has a value greater than 100. Please specify a number between 0 and 100.

400 Bad Request

Invalid integer in query (limit=xxx)

The limit parameter has an invalid value. Please specify a number between 0 and 100.

400 Bad Request

Invalid boolean in query (imageOnly=xxx)

The imageOnly parameter has an invalid value. Please specify true or false.

400 Bad Request

Offset: must be no less than 0

The offset parameter has an invalid value. Please specify a number greater than or equal to 0.

400 Bad Request

Invalid integer in query (offset=xxx)

The offset parameter has an invalid value. Please specify a number greater than or equal to 0.

400 Bad Request

BadRequest

The value of the token parameter is invalid or the token is expired.

404 Not Found

Content not found

No media exists with the filename specified in the fileName parameter.

Status Code

Error Message

Cause and Solution

400 Bad Request

invalid request

The format of the request is invalid. Please check the contents of the request body.

400 Bad Request

request body too large

The file size of the media being uploaded exceeds 5MB. Please reduce the size or upload it from the management screen.

405 Method Not Allowed

Method Not Allowed

This is a request with an unsupported method. Please check if the URL is correct.

Status Code

Error Message

Cause and Solution

400 Bad Request

invalid url

The specified URL is invalid. Please check if the URL is correct.

400 Bad Request

this medium is referenced by another content

Cannot be deleted because it is referenced by content. Please remove the reference to the media from the source content.

404 Not Found

medium not found

The media to be deleted does not exist. Please check if the correct media URL is specified.

405 Method Not Allowed

Method Not Allowed

This is a request with a method that is not allowed. Please check if the URL is correct.

Status Code

Error Message

Cause and Solution

404 Not Found

Member not found

The member you are trying to retrieve does not exist or is still pending invitation. Please specify a member who has already joined the service.