error_codes.md

API Error codes

This table shows error codes and their associated descriptions. Strings enclosed by '$' are replaced during error processing. Note that code "1009" is a special "non-error" error code that is used to indicate "success" when an API call returns a 200 Response without any accompanying JSON output of its own. "14001" is one other example of a "non-error" error.

(See Errors for furtherdetails.)

domain	error code	message
miscellaneous	-------	-----------------------------------------
misc	1000	"Exception: $reason$"
misc	1001	"Key is not master."
misc	1002	"Request unknown or not implemented."
misc	1003	"Id is invalid.";
misc	1004	"No network found."
misc	1005	"Name cannot be empty."
misc	1006	"Missing parameter."
misc	1007	"Access point ($mac$) not found."
misc	1008	"Mac address ($mac$) is in the wrong format. Must match regx $regx$."
misc	1009	"Success"
misc	1016	"Internal error."
misc	1017	"Element not found."
misc	1018	"Incorrect API privileges."
misc	1019	"Internal error."
general info	-------	-------
general	10000	"You have one or more access points that are not upgradeable. These may include generic_ap51, OM1P, MR500 or older OM2P APs. Please try again once these are removed from your network."
general	10001	"Your current captive portal is CoovaChilli, which is not available in the upgraded firmware. Please select a different captive portal configuration and try again."
general	10002	"Some access points are running an older firmware version that requires them to be online before the upgrade can start. Please bring them online or remove them from the network."
history	-------	-------
history	11000	"Client list cannot be empty."
history	11001	"Client id cannot be 0."
history	11002	"Client name cannot be empty."
network managment	-------	-------
network	12000	"Network not found, create or migrate first."
network	12001	"String length ($length$) out of range ($min$ - $max$)."
network	12002	"Invalid characters. Used regx: $regx$."
network	12003	"Unknown timezone."
network	12004	"Int value ($value$) out of range ($min$ - $max$)."
network	12005	"Unknown country code."
network	12006	"Unknown ht_mode, expect (HT20/HT40+/HT40-/HT80+/HT80-/HT160+/HT160-)."
network	12007	"Invalid channel."
network	12008	"Unknown firmware release."
network	12009	"More than 4 ssids are not allowed."
network	12010	"Invalid day(s), use su
network	12011	"No id given."
network	12012	"Id not found, use 0 to create a new entry."
network	12013	"Too many elements or elements too large. Max is $max$."
network	12014	"Unknown login method."
network	12015	"Unknown splash page."
network	12016	"Unknown auth type."
network	12017	"Vlan tag "$tag$" is already in use."
network	12018	"Too many entries. Maximum is $max."
network	12019	"No entry. Minimum is 1."
network	12020	"SSID ($id$) does not exist."
network	12021	"Facebook gateway registration error (id: $id$)."
network	12022	"Name already exists."
network	12023	"Bcrypt error."
network	12024	"Role should be 'image', 'page', or 'file'."
network	12025	"File size ($size$) is too large. Max is $max$."
network	12026	"Upload failure"
network	12027	"Bad ssid id"
network	12028	"Bad file id"
network	12029	"Error during the delete process"
network	12030	"File missing."
network	12047	"Not permitted by network id."
network	19007	"Network name invalid."
authentication	-------	-------
auth	13000	"Signature wrong."
auth	13001	"No nonce or timestamp in header."
auth	13002	"Timestamp too old or in the future."
auth	13003	"Nonce already exists."
auth	13004	"Version is not valid."
auth	13005	"Unauthorized access from key $key$."
auth	13006	"Read-only key does not have access to all components."
auth	13007	"Expired key"
auth	13008	"Master is not allowed access."
auth	13009	"Network id doesn't match key."
auth	13010	"No network id or master given."
auth	13011	"Unknown key."
auth	13012	"Nonce length ($length$) too long. Max is $max$."
auth	13015	"Empty signature header."
auth	13016	"Key is expired."
account management	-------	-------
accounts	14000	"User name cannot be empty."
accounts	14001	"Deletion of key/secret succeeded."
accounts	14002	"Deletion of key/secret failed."
accounts	14003	"Method $method$ is unknown."
account (user management) management	-------	-------
account	50000	"Account not found."
account	50001	"No permission to update this account."
account	50002	"There is already an account with this name. Choose another name."
account	50003	"Invalid name."
cloud AP's	-------	-------
cloud	16000	"Id invalid or pairing disabled."
cloud	16001	"Mis-match of mac addresses: mac: 1. $auth_mac$ 2. $primary_mac$ 3. $node_mac$."
cloud	16002	"No old settings."
cloud	16003	"Key mac ($auth_mac$) doesn't match AP mac ($node_mac$)."
cloud	16004	"Voucher string length ($len$) is too long. Max is $max$."
cloud	16005	"Failure getting access point data."
cloud	16006	"Failure getting health care data."
cloud	16007	"Failure storing remote log."
network group management	-------	-------
network group	40000	"Cannot move network. No networkgroup destination specified."
network group	40001	"Cannot move network. There are still user-permissions for this network."
network group	40002	"Cannot move network. Network with given id does not exist."
network group	40003	"Network group not found."
network group	40004	"Cannot remove networkgroup. There are still networks in this group. First remove or move the networks."
network group	40005	"In this account there is already a networkgroup with this name. Choose another name."
network group	40006	"Not permitted by networkgroup id"
network group	40007	"Must have Network Admin privileges"
network group	40008	"Invalid networkgroup name length."
node management	-------	-------
nodes	17000	"Mac ($mac$) already exists in your network."
nodes	17001	"Mac ($mac$) already exists in another of your networks, but you have not set 'confirm_transfer' true."
nodes	17002	"Mac ($mac$) already exists in another network."
nodes	17003	"Could not delete access point (id $id$)."
nodes	17004	"Could not reboot access point (id $id$)."
nodes	17005	"Could not reset encrypt key access point (id $id$)."
nodes	17006	"Could not enable pairing for access point (id $id$)."
nodes	17007	"Could not expedite upgrade for access point (id $id$)."
permissions	-------	-------
permissions	30000	"The needed user-role is not defined."
permissions	30001	"No permissions for this request."
permissions	30002	"No permissions to access this resource."
user management	-------	-------
users	20000	"Email already exists."
users	20001	"Could not verify user."
users	20002	"User is not verified."
users	20003	"Wrong password."
users	20004	"User not found."
users	20005	"No permission for this component and method."
users	20006	"Only one parameter of role or custom_permission is allowed in one request."
users	20007	"Password size must be between 8 and 50 characters."
users	20008	"Wrong verification error."
users	20009	"User is already verified."
users	20010	"E-Mail is not in a valid format."
users	20011	"Something went wrong with generating error/secret."
users	20012	"Cannot create user with the given error."
users	20013	"Wrong resource-id for user."
users	20014	"cannot create and add user to account. The role of the new user must be specified."
users	20015	"cannot create and add user to account. Not permitted."
users	20016	"cannot add user with given user-role to networkgroup. Not permitted."
users	20017	"Cannot add user to networkgroup. No Role specified."
users	20018	"Cannot grant user-permission for network. No Role specified."
users	20019	"Cannot revoke user-permission from networkgroup. No permission found for user-id and networkgroup-id."
users	20020	"cannot revoke user-permission from networkgroup. Not permitted."
users	20021	"Cannot revoke user-permission from network. No permission found for user-id and network-id."
users	20022	"cannot revoke user-permission from network. Not permitted."
users	20023	"Cannot delete user. Not permitted."
users	20024	"Cannot delete yourself."
users	20025	"Cannot delete user. User has permissions to more networks."
users	20026	"Cannot retrieve user-data. Not permitted"
users	20027	"Cannot add user to networkgroup. User is not in same account."
users	20028	"Cannot add user to network. User is not in same account."
users	20029	"Not permitted by user ID."
users	20030	"Password required."
users	20031	"Password updates are only permitted by the user."
users	20032	"Token required."
users	20033	"Too many attempts. Please contact support."
users	20034	"User disabled."
users	20035	"Cannot delete the account creator."
users	20036	"User name is required."
users	20037	"Email is required."
users	20038	"User is not in the same account."
users	20039	"User must be an account admin."
users	20040	"User must be the account owner."
users	20041	"User has reached maximum login attempts. Reset password."
users	20042	"API users must be created via an Account Owner or Account Admin, not an Application API key."
users	20043	"API key does not belong to the specified user."
users	20044	"User has too many API keys."
users	20045	"API users cannot have passwords."
users	20047	"User must be able to login before being assigned as the owner."