Portal Home > Knowledgebase > API > What do your API response codes mean?


What do your API response codes mean?




Below is a list of our API Resonse Codes and an explanation of what they mean:

Code Response Type Description
1000 Command completed successfully Response for a successfully completed command.
2000 Unknown command Response to a command that is not defined. Defined commands are info, create, renew, updatenameservers, updatecontacts and getCredits.
2001 Command syntax error Response code to an improperly formed command.
2002 Command use error Response code to a properly formed command but the command cannot be executed due to a sequencing or context error.
2003 Required parameter missing Response code to a command for which a required parameter value has not been provided.
2004 Parameter value range error Response code to a request containing a command parameter which is out of the required range.
2005 Parameter value syntax error Response code to a request containing a parameter whose value is improperly formed. For example, this code is returned when a British postcode or domain name is improperly formed.
2104 Billing failure Response code to a command to execute a billable operation and the command cannot be completed due to a client billing failure. This is returned when a create/renew command is sent and there are not sufficient credits to carry out the registration or renewal.
2105 Object is not eligible for renewal Response code when a command attempts to renew an object that is not eligible for renewal. This is returned when a request to renew a domain name which is not passed 6 months before expiry is sent.
2200 Authentication error Response code when there is an error when validating client credentials, i.e. the password provided on login is wrong. Check your login details in Setup > Domain Registrars > magdomains.
2201 Authorisation error Response code when there is a client authorisation error when executing a command. This can be returned for a number of reasons including Invalid Client IP and attempts to query or transfer a domain which is not currently on the MAGDESIGN tag.
2302 Object exists Response code to a request to create an object that already exists in the database. Our server returns this code to a request to register a domain name that is already registered.
2303 Object does not exist Response code to a request to modify or query an object that does not exist.
2306 Parameter policy error Response code to a command containing a parameter value that is syntactically valid, but semantically invalid. For example, this is returned to a request to register a .com domain name.
2400 Command failed This response code is returned when the server is unable to complete a modify, release or renewal command due to database blocking. This error code may be received during the hours of 2 and 4am each day when a large processes are run on our servers.


Was this answer helpful?

Add to Favourites Add to Favourites    Print this Article Print this Article

Also Read

Powered by WHMCompleteSolution