This document summarizes the errors that occur when making requests to the Management API, categorized by type.
The information below is not guaranteed to cover all status codes that may occur in the event of an error. Please note that other errors may also occur due to unexpected issues or oversights.
Management API error responses may include a message like the following in the response body.
{
message: "some message"
}Error messages are subject to change without notice. Please do not implement handling based on error messages.
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| 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 |
| 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 |
| The requested URL is incorrect. Please check for any typos in the URL. |
429 Too Many Requests |
| You have exceeded the API call limit. |
500 Internal Server Error |
| An unexpected error has occurred on the server side. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| A value less than 0 was specified for the |
400 Bad Request |
| A value greater than 100 was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| A value less than 0 was specified for the |
400 Bad Request |
| An invalid value was specified for the |
404 Not Found |
| The Content to retrieve does not exist. Check that the specified Content ID is correct. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| An invalid value is specified in the body. Please check the content of the body. |
400 Bad Request |
| A past date and time has been specified for the scheduled publication. Please specify a future value relative to the current time. |
400 Bad Request |
| A past date and time has been specified for the scheduled end of publication. Please specify a future value relative to the current time. |
400 Bad Request |
| You are trying to set a reservation for content that is under review. Please complete or withdraw the review before setting the reservation. |
400 Bad Request |
| You are specifying a reservation to start publication for content that is already published. Please set a reservation to end publication first, or remove the reservation to start publication from the body. |
400 Bad Request |
| If the content is currently published, the reservation to start publication must be set after the reservation to stop publication. Please specify the end reservation first and the start reservation later. |
400 Bad Request |
| You are specifying only a reservation to end publication for draft content. Please also set a reservation to start publication, or remove the reservation to end publication from the body. |
400 Bad Request |
| The reservation to end publication for draft content must be set after the reservation to start publication. Please specify the start reservation first and the end reservation later. |
400 Bad Request |
| You are specifying only a reservation to end publication for content that is closed to the public. Please also set a reservation to start publication, or remove the reservation to end publication from the body. |
400 Bad Request |
| The order of the start/end reservations specified for closed content is incorrect. Please set the start reservation first and the end reservation later. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| An invalid value is specified in the body. Please check the content of the body. |
400 Bad Request |
| An invalid value is specified in the body. Please check the content of the body. |
400 Bad Request |
| An invalid user ID is specified in the body. Please specify an existing user ID. |
400 Bad Request |
| The JSON format specified in the body is incorrect. Please check the content of the body. |
405 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 |
| A value less than 0 was specified for the |
400 Bad Request |
| A value greater than 100 was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| The value of the |
404 Not Found |
| No media item with the specified string as its file name exists for the |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| The format of the request is invalid. Please check the contents of the request body. |
400 Bad Request |
| The file size of the media being uploaded exceeds 5MB. Please reduce the size or upload it from the Administration console. |
405 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 |
| The specified URL is invalid. Please check if the URL is correct. |
400 Bad Request |
| It cannot be deleted because it is referenced by another content. Please remove the reference to the media from the source content. |
404 Not Found |
| The media to be deleted does not exist. Please check if the correct media URL is specified. |
405 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 |
|---|---|---|
404 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. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request | Examples:
| The request body is invalid. Check that |
400 Bad Request |
| The member ID is invalid. Specify a member ID included in the response from the API for retrieving the member list. |
400 Bad Request | Examples:
|
|
400 Bad Request | Example: | The specified role does not exist in the target Service. Check that the role belongs to the correct Service and that the specified role ID is correct. |
403 Forbidden |
| Member roles cannot be updated in environments created using the Multiple Environments feature. Check the Service ID in the request URL. |
404 Not Found |
| The specified member does not exist in the Service. Use the API for retrieving the member list to check whether the specified member ID exists in the target Service. |
409 Conflict |
| The specified member has been invited but has not yet joined. Retry the request after the member has joined the Service. |
409 Conflict |
| After the update, no joined members in the Service will have the administrator role. Check the role IDs specified in |
413 Payload Too Large |
| The request body exceeds 1 MiB. Adjust the request body so that it is no larger than 1 MiB. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| The Endpoint format is invalid. Check that the specified Endpoint is correct. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request | Examples:
| The request body is invalid. Check that all required fields are specified, that values have the correct types, and that the request does not contain undefined properties or properties that are not supported for the specified field type. |
400 Bad Request | Examples:
| The type of |
400 Bad Request | Example: |
|
400 Bad Request | Examples:
|
|
400 Bad Request |
| An invalid value is specified for the |
402 Payment Required |
| On the Team plan, Business plan, or Enterprise plan, you are trying to create an API that exceeds the API limit without specifying |
403 Forbidden |
| On the Hobby plan or Template plan, you are trying to create an API that exceeds the API limit. These plans do not allow you to exceed the limit, regardless of the value specified for |
403 Forbidden |
| A File Field that is not available on your current Plan is specified. Check whether the request body contains a File Field and whether it is available on your Plan. |
409 Conflict | Example: | An API using the specified Endpoint already exists. Specify an Endpoint that is unique within the Service. |
413 Payload Too Large |
| The request body exceeds 1 MiB. Adjust the request body so that it is no larger than 1 MiB. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| A value greater than 100 was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| An invalid value was specified for the |
400 Bad Request |
| The contents of the |
400 Bad Request |
| The role ID format is invalid. Specify a UUID-formatted value using lowercase letters for |
403 Forbidden |
| Roles cannot be retrieved in environments created using the Multiple Environments feature. Check the Service ID of the target service. |
404 Not Found |
| The role to retrieve does not exist. Check that the specified role ID is correct. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request | Examples:
| The request body is invalid. Check that all required fields are specified, that values are of the correct type and not |
400 Bad Request | Example:
| A member, environment, or API that does not exist or cannot be specified was provided. Check that the request does not include members who have been invited or members or environments from another Service, and verify that the specified API ID is correct. |
403 Forbidden |
| Your current Plan does not support the Role feature. Check which Plans support the Role feature (Business and Enterprise). |
403 Forbidden |
| Roles cannot be created in environments created using the Multiple Environments feature. Check the Service ID specified in the request. |
413 Payload Too Large |
| The request body exceeds 1 MiB. Adjust the request body so that it is no larger than 1 MiB. |
Status Code | Error Message | Cause and Resolution |
|---|---|---|
400 Bad Request |
| The role ID format is invalid. Specify a UUID-formatted value using lowercase letters for |
400 Bad Request |
| Neither |
400 Bad Request | Examples:
| The request body is invalid. If you specify |
400 Bad Request | Example:
| A member, environment, or API that does not exist or cannot be specified was provided. Check that the request does not include invited members or members or environments from another Service, and verify that the specified API ID is correct. |
403 Forbidden |
| The Administrator role was specified. The Administrator role cannot be updated. Check the role ID of the role you want to update. |
403 Forbidden |
| Roles cannot be updated in environments created using the Multiple Environments feature. Check the Service ID in the request destination. |
404 Not Found |
| The role to be updated does not exist in the Service. Check that the specified role ID is correct. |
413 Payload Too Large |
| The request body exceeds 1 MiB. Adjust the request body so that it is no larger than 1 MiB. |
Status Code | Error Message | Cause and Solution |
|---|---|---|
400 Bad Request |
| The role ID format is invalid. Specify a UUID-formatted value using lowercase letters for |
403 Forbidden |
| The Administrator role was specified. The Administrator role cannot be deleted. Check the role ID to be deleted. |
403 Forbidden |
| Roles cannot be deleted in environments created using the Multiple Environments feature. Check the Service ID in the request destination. |
404 Not Found |
| The role to be deleted does not exist in the Service. Check that the specified role ID is correct. |
409 Conflict |
| The role to be deleted is assigned to one or more members, including members who have been invited. Remove the role from all members to whom it is assigned, including invited members, and then submit the request again. |