Errors
This page lists the possible errors you might encounter and what they mean.
Error object
{name: "REQUESTED_ENTITY_NOT_FOUND"code: 10004message: "List not found"}namestringThe name of the error.codenumberThe error code.messagestringA human-readable message describing the error.
Error codes
General error codes
10000UNKNOWNAn unknown error occurred.500 Interval Server Error10001MAINTENANCE_MODEjsonpad.io is currently in maintenance mode.502 Bad Gateway10002MALFORMED_REQUESTSomething in the request was malformed. Usually this is due to a missing token value.400 Bad Request10003VALIDATION_ERRORThe request failed validation. Details about the validation error will be included in the message. This could be due to a missing or invalid field in the request body, or the request body didn't match a JSON Schema when creating or updating an item.400 Bad Request10004REQUESTED_ENTITY_NOT_FOUNDThe requested entity (list, item, or index) was not found.404 Not Found10007RATE_LIMIT_EXCEEDEDThe rate limit for the API has been exceeded. Too many requests were sent in a short period of time, or requests were sent too quickly. See Rate Limits for more information.429 Too Many Requests10008MAX_LISTS_EXCEEDEDYour subscription plan has a limit on the number of lists you can create, and you have reached that limit.403 Forbidden10009MAX_ITEMS_EXCEEDEDYour subscription plan has a limit on the number of items you can create in a list, and you have reached that limit for the list in which you are trying to create an item.403 Forbidden10010MAX_INDEXES_EXCEEDEDYour subscription plan has a limit on the number of indexes you can create in a list, and you have reached that limit for the list in which you are trying to create an index.403 Forbidden10012MAX_IDENTITIES_EXCEEDEDYour subscription plan has a limit on the number of identities you can create, and you have reached that limit.403 Forbidden10013QUOTA_EXCEEDEDYou have used your monthly request allowance, any overdraft your plan includes, and any prepaid request credits you hold.429 Too Many RequestsGETrequests keep working; writes are refused until the allowance resets or you buy more requests. See limits and quotas.10014STORAGE_LIMIT_EXCEEDEDYou have reached your plan's total storage allowance. Reads keep working; writes are refused until you delete some data or move up a plan.403 Forbidden10015REALTIME_CONNECTION_LIMIT_EXCEEDEDYour account already holds as many concurrent realtime connections as your plan allows. This one arrives as a429 Too Many Requestsconnect_errorwhile connecting rather than as an HTTP response, and its data carries the limit and how long to wait before trying again. See realtime updates.13001TOKEN_NOT_AUTHORIZEDThe token you provided is not authorized to perform the requested action. See Token Permissions for more information.403 Forbidden13002TOKEN_LOCKEDThe token you provided has been temporarily locked. This occurs when your subscription plan expires or you downgrade to a plan with a lower limit. In this case, any tokens that exceed the new limit will be locked but not deleted. You can unlock the token by upgrading your subscription plan or deleting some tokens.403 Forbidden17001SEARCH_QUERY_INVALIDThe search query provided in the request was too short. The search query must be at least 3 characters long.400 Bad Request
List error codes
14001LIST_READONLYThe list is read-only and cannot be modified. This includes items and indexes as well - you can't create, update, or delete items or indexes in a read-only list.403 Forbidden14002LIST_PROTECTEDYou tried to delete a protected list that still has some items in it. You will need to delete all items in the list before you can delete the list.403 Forbidden14003LIST_RESERVED_PATH_NAMEThe path name you provided is reserved. Some path names might be reserved for internal use, or they might cause ambiguity in URLs. Try a different path name.403 Forbidden14004LIST_LOCKEDThe list has been temporarily locked. This occurs when your subscription plan expires or you downgrade to a plan with a lower limit. In this case, any lists that exceed the new limit will be locked but not deleted. You can unlock the list by upgrading your subscription plan or deleting some lists.403 Forbidden14005LIST_UNABLE_TO_CREATEAn error occurred while creating the list. This could be due to a duplicate path name (the path name must be unique across all of your lists).400 Bad Request14006LIST_UNABLE_TO_UPDATEAn error occurred while updating the list.400 Bad Request14007LIST_UNABLE_TO_DELETEAn error occurred while deleting the list.400 Bad Request14008LIST_NOT_INDEXABLEThe list is not indexable. You cannot view a list of items in a non-indexable list. Also, non-indexable lists cannot be searched.403 Forbidden
Item error codes
15001ITEM_READONLYThe item is read-only and cannot be modified.403 Forbidden15002ITEM_LOCKEDThe item has been temporarily locked. This occurs when your subscription plan expires or you downgrade to a plan with a lower limit. In this case, any items that exceed the new limit will be locked but not deleted. You can unlock the item by upgrading your subscription plan or deleting some items.15003ITEM_UNABLE_TO_CREATEAn error occurred while creating the item.400 Bad Request15004ITEM_UNABLE_TO_RESTOREAn error occurred while restoring the item.400 Bad Request15005ITEM_UNABLE_TO_UPDATEAn error occurred while updating the item.400 Bad Request15006ITEM_UNABLE_TO_DELETEAn error occurred while deleting the item.400 Bad Request15007ITEM_TOO_LARGEThe item's data is too large. The maximum size for an item's data will depend on your subscription plan.413 Request Too Long15008ITEM_VERSION_NOT_FOUNDThe requested version of the item was not found.404 Not Found15009ITEM_JSON_POINTER_NOT_FOUNDThe requested JSON pointer was not found in the item. This occurs when trying to create, update, or delete partial data at a specific path in the item's data.404 Not Found15010ITEM_UNABLE_TO_GENERATEAn error occurred while generating the item.400 Bad Request15012ITEM_VERSION_NOT_RETAINEDThe requested version of the item is older than the number of versions your plan retains. The version still exists in the event log, but it can no longer be fetched as an item version. See limits and quotas.410 Gone15013ITEM_PRECONDITION_FAILEDThe412 Precondition Failedif-matchheader didn't match the item's current ETag, so the item has changed since you last read it. Nothing was written. See conditional writes.15014ITEM_CONFLICTThe item was changed by another request while this one was writing it. Nothing was written. Fetch the item again and retry.409 Conflict
Index error codes
16001INDEX_RESERVED_PATH_NAMEThe path name you provided is reserved. Some path names might be reserved for internal use, or they might cause ambiguity in URLs. Try a different path name.403 Forbidden16002INDEX_LOCKEDThe index has been temporarily locked. This occurs when your subscription plan expires or you downgrade to a plan with a lower limit. In this case, any indexes that exceed the new limit will be locked but not deleted. You can unlock the index by upgrading your subscription plan or deleting some indexes.403 Forbidden16003INDEX_UNABLE_TO_CREATEAn error occurred while creating the index.400 Bad Request16004INDEX_UNABLE_TO_UPDATEAn error occurred while updating the index.400 Bad Request16005INDEX_UNABLE_TO_DELETEAn error occurred while deleting the index.400 Bad Request16006INDEX_BUILDINGThe request needs an index that is still being built, e.g. to filter or order items, or to look up an item by alias. Wait for the number of seconds in the409 ConflictRetry-Afterheader, then try again. See index builds.16007INDEX_BUILD_FAILEDThe request needs an index whose build failed. Fix the problem (e.g. items sharing an alias value), then rebuild the index. See failed builds.409 Conflict16008INDEX_BUILD_NOT_FAILEDOnly an index whose build failed can be rebuilt. The index is either ready, or already being built.409 Conflict
Identity error codes
20001IDENTITY_RESERVED_NAMEThe identity name you provided is reserved. Some names might be reserved for internal use, or they might cause ambiguity in URLs. Try a different name.403 Forbidden20002IDENTITY_LOCKEDThe identity has been temporarily locked. This occurs when your subscription plan expires or you downgrade to a plan with a lower limit. In this case, any identities that exceed the new limit will be locked but not deleted. You can unlock the identity by upgrading your subscription plan or deleting some identities.403 Forbidden20003IDENTITY_UNABLE_TO_CREATEAn error occurred while creating the identity.400 Bad Request20004IDENTITY_UNABLE_TO_UPDATEAn error occurred while updating the identity.400 Bad Request20005IDENTITY_UNABLE_TO_DELETEAn error occurred while deleting the identity.400 Bad Request20006IDENTITY_ALREADY_REGISTEREDYou tried to register a new identity while authenticated as an existing identity. Logout or omit identity authentication headers and try again.403 Forbidden20007IDENTITY_ALREADY_AUTHENTICATEDYou to tried to login using an identity while authenticated as an existing identity. Logout or omit identity authentication headers and try again.403 Forbidden20008IDENTITY_NOT_AUTHENTICATEDAn incorrect identity token was provided, or no identity token was provided when accessing and endpoint that requires identity authentication.401 Unauthorized20009IDENTITY_TOO_MANY_ATTEMPTS429 Too Many RequestsIdentity authentication failed too many times in a short period of time. This helps to protect against brute force attacks.
The amount of time you need to wait before trying again will increase on every failed attempt. Try again in a few minutes.
20010IDENTITY_EMAIL_IN_USEAnother identity in the same group already has this email address (email addresses are compared ignoring case). Each email address can only be used once per group.409 Conflict20011IDENTITY_RESET_TOKEN_INVALIDThe password reset token doesn't exist, has already been used, has expired, or was replaced by a newer token. Tokens also stop working if the identity's email address changes. Request a new one. See password reset.400 Bad Request20012IDENTITY_VERIFICATION_TOKEN_INVALIDThe email verification token doesn't exist, has already been used, has expired, or was sent to an email address the identity no longer has. Request a new one.400 Bad Request20013IDENTITY_GROUP_NOT_EMPTYAn identity group can only be deleted once it has no identities. Delete the identities, or move them to another group, first.409 Conflict20014IDENTITY_GROUP_ALREADY_EXISTSAn identity group with this name already exists. Groups are also created automatically the first time an identity uses one.409 Conflict20015IDENTITY_OAUTH_PROVIDER_NOT_CONFIGUREDThis sign-in provider isn't set up, or isn't enabled, for the identity group. Set it up on the group's page in the dashboard.400 Bad Request20016IDENTITY_OAUTH_REDIRECT_NOT_ALLOWEDThe400 Bad RequestredirectUrlisn't one of the identity group's redirect URLs. They're compared exactly, so a missing slash or a different port counts as a different URL.20017IDENTITY_OAUTH_STATE_INVALIDThe sign-in has expired (they last 10 minutes), has already been completed, or is being completed by a different browser or API token. Start signing in again.400 Bad Request20018IDENTITY_OAUTH_CANCELLEDThe person decided not to sign in with the provider. Show your sign-in page again rather than an error.400 Bad Request20019IDENTITY_OAUTH_PROVIDER_ERRORThe provider refused, or couldn't be reached. The message says what to do: check the client ID and secret, register the callback URL with the provider, or start signing in again.502 Bad Gateway20020IDENTITY_OAUTH_NOT_REGISTEREDNo identity is linked to this provider account, and the API token can't register identities. Add the403 Forbiddenregisterpermission for the group.20021IDENTITY_PROVIDER_ALREADY_LINKEDThis provider account is already linked to an identity, or this identity already has an account with this provider.409 Conflict20022IDENTITY_LAST_LOGIN_METHODThis is the identity's last way of signing in. Set a password, or link another account, before unlinking it.409 Conflict20023IDENTITY_EMAIL_REQUIREDThe identity's group requires an email address, and the identity doesn't have one (or the request would remove it). See identity groups.400 Bad Request20024IDENTITY_CURRENT_PASSWORD_INCORRECTAn identity tried to change its own password or email address without giving its current password in403 ForbiddencurrentPassword, or the password was wrong. Failed attempts count towardsIDENTITY_TOO_MANY_ATTEMPTS.21001SCHEMA_SYNC_INVALID_DOCUMENTThe schema sync document isn't valid, e.g. it has an unknown field, or declares the same list twice. The message says what's wrong. See the document.400 Bad Request21002SCHEMA_SYNC_PLAN_HAS_ERRORSA schema sync, or a move between scopes, wasn't applied, because one or more of its changes would be refused. Nothing was changed. The response includes the plan, with the errors for each change. See sync a schema and move lists between scopes.422 Unprocessable Entity21003SCHEMA_SYNC_REBUILD_NOT_ALLOWEDA schema sync wasn't applied, because it changes the pointer of an index in a list that has items, which makes the index unusable until it's rebuilt. Pass422 Unprocessable EntityallowRebuild=trueto allow this. See index rebuilds.21004SCHEMA_SYNC_PRUNE_NOT_SUPPORTEDNo longer returned: schema sync supports pruning.400 Bad Request21005SCHEMA_SYNC_OWNERSHIP_CONFLICTA list or index in the document is managed by a different scope. It can only be synced by a document with that scope, unless you move the list first. See scopes.409 Conflict21006SCHEMA_SYNC_RESOURCE_UNAVAILABLEA list or index in the document exists, but is deactivated or locked, so it can't be synced with an API token.409 Conflict21007SCHEMA_SYNC_PRUNE_NEEDS_SCOPEA sync with400 Bad Requestprune=truewas sent a document without ascope. A prune only deletes what a scope manages. See pruning.21008SCHEMA_SYNC_DESTRUCTIVE_NOT_ALLOWEDA schema sync wasn't applied, because its prune would delete a list that has items, or a guard index. Pass422 Unprocessable EntityallowDestructive=trueto allow this. See destructive deletes.21009SCHEMA_SYNC_PRUNE_WOULD_EMPTY_SCOPEA schema sync wasn't applied, because the document declares no lists, so its prune would delete every list the scope manages. This can't be overridden. See pruning.422 Unprocessable Entity
Write rule error codes
These come from a list's write rules. The first two are what a client sees when a rule refuses its write; the rest are what you see when you save a rule set that doesn't hold up.
22001WRITE_RULE_DENIEDNo403 Forbiddenallowstatement authorised the write, or the rules ran out of evaluation budget. The message is deliberately the same every time, so a refused client learns nothing about your rules.details.operationsays which operation was refused.22002WRITE_RULE_FAILEDA400 Bad Requestrequirestatement failed. The message is the one the rule's author wrote afterelse, anddetailscarries the operation, the rule's label and the line it's on.22003WRITE_RULES_INVALIDThe rules you tried to save don't compile. Nothing was saved, and400 Bad Requestdetails.diagnosticslists every problem, each with the place in the rule text it's at.22004WRITE_RULE_TESTS_INVALIDThe rule tests you tried to save aren't a valid test document.400 Bad Requestdetails.errorssays what's wrong with each one.22005WRITE_RULE_TESTS_FAILEDThe rules compiled, but their tests don't pass, so nothing was saved.400 Bad Requestdetails.failureslists each failing test with what it expected and what happened instead.