Debugging API Problems

Audience

  • Software Developers working to integrate ordering/billing software into InterWorx
  • Web hosts experiencing problems creating accounts

Purpose

This document explains the meaning of the various error codes that the InterWorx Control Panel API can give.

Last updated InterWorx 3.0 DEV.

Introduction

Whenever the InterWorx API receives a value it does not understand or know what to do with, it returns a numerical error value in the /chroot/home/interworx/var/log/error.log. This information can be used to determine the problem and fix it.

Error Codes

Meaning Code #
'API_ERROR_INVALID_ARGS' 99
'API_ERROR_INVALID_IP_TYPE' 801
'API_ERROR_NO_SHARED_IPS' 802
'API_ERROR_NO_STATIC_IPS' 803
'API_ERROR_UNKNOWN_IP_RULE' 804
'API_ERROR_ZONE_EXISTS' 901
'API_ERROR_DOMAIN_EXISTS' 902
'API_ERROR_EMPTY_EMAIL' 903
'API_ERROR_EMPTY_DOMAIN' 904
'API_ERROR_EMPTY_IP' 905
'API_ERROR_EMPTY_PASSWORD' 906
'API_ERROR_INVALID_IP' 908
'API_ERROR_IP_IN_USE' 909
'API_ERROR_NO_IPS_AVAILABLE' 910
'API_ERROR_SUBDOMAIN_EXISTS' 911
'API_ERROR_INVALID_DOMAIN' 912
'API_ERROR_INVALID_EMAIL' 913
'API_ERROR_UNKNOWN_PACKAGE' 914
'API_ERROR_UNKNOWN_PACKAGE_ID' 915
'API_ERROR_INVALID_BILLING_DAY' 916
'API_ERROR_SITEWORX_SAVE_FAILED' 917
'API_ERROR_PACKAGE_SAVE_FAILED' 918
'API_ERROR_SETTING_MASTER_DOMAIN' 919
'API_ERROR_ACTIVATING_ACCOUNT' 920
'API_ERROR_MAPPING_ACCOUNT' 921
'API_ERROR_CREATING_SITEWORX_USER' 922
'API_ERROR_EDITING_SITEWORX_USER' 923
'API_ERROR_EDITING_SITEWORX_PACKAGE' 924
'API_ERROR_EDITING_SITEWORX_ACCOUNT' 925
'API_ERROR_UID_DOESNT_MATCH_USER' 926
'API_ERROR_GID_DOESNT_MATCH_USER' 927
'API_ERROR_UID_EXISTS' 928
'API_ERROR_GID_EXISTS' 929
'API_ERROR_EMPTY_LANGUAGE' 930
'API_ERROR_EMPTY_STATUS' 940
'API_ERROR_INVALID_PACKAGE_OPTION' 950
'API_ERROR_UNIQNAME_EXISTS' 960
'API_ERROR_INVALID_UNIQNAME' 961
'API_ERROR_RESELLER_STORAGE_REACHED' 970
'API_ERROR_RESELLER_ACCOUNT_REACHED' 971
'API_ERROR_RESELLER_CHANGE_NOT_ALLOWED' 972
'API_ERROR_RESELLER_MISSING_NAMESERVERS' 973
'API_ERROR_DOMAIN_SUSPENDED' 1001
'API_ERROR_DOMAIN_NOT_FOUND' 1002
'API_ERROR_DOMAIN_UNSUSPENDED' 1101
'API_ERROR_SITEWORX_DELETE' 1102
'API_ERROR_PACKAGE_EXISTS' 1301
'API_ERROR_NO_PACKAGE' 1414
'API_ERROR_LOAD_PACKAGE' 1415
'API_ERROR_MOUNT_ALREADY_EXISTS' 2000
'API_ERROR_DIRECTORY_DOES_NOT_EXIST' 2001
'API_ERROR_INVALID_REMOTE_DIRECTORY' 2002
'API_ERROR_INVALID_HOST' 2003
'API_ERROR_INVALID_OPTION' 2004
'API_ERROR_MOUNT_FAILED' 2005
'API_ERROR_UNMOUNT_FAILED' 2006
'API_ERROR_EXPORT_FAILED' 2007
'API_ERROR_UNEXPORT_FAILED' 2008
'API_ERROR_INVALID_ROLE' 2020
'API_ERROR_NODE_NOT_CLUSTERED' 2021
'API_ERROR_INI_UPDATE_FAILED' 2030
'API_ERROR_SQL_FILE_UPDATE_FAILED' 2031
'API_ERROR_NO_BACKUP_DSN' 2032
'API_ERROR_INVALID_VIP' 2033
'API_ERROR_VIP_BIND_FAILED' 2034
'API_ERROR_VIP_UNBIND_FAILED' 2035
'API_ERROR_INVALID_NODEWORX_ACCOUNT' 2040
'API_ERROR_INVALID_SITEWORX_ACCOUNT' 2041
'API_ERROR_DNSSYNC_HOST_EXISTS' 2050
'API_ERROR_DNSSYNC_RESOLVING_HOST' 2051
'API_ERROR_DNSSYNC_RESOLVED_IP_DIFF' 2052
'API_ERROR_DNSSYNC_HOST_IS_SELF' 2053
'API_ERROR_DNSSYNC_HOST_IS_ACTIVE' 2054
'API_ERROR_DNSSYNC_HOST_SAVE_FAILED' 2055
'API_ERROR_DNSSYNC_HOST_ISNT_ACTIVE' 2056
'API_ERROR_DNSSYNC_VALIDATION' 2057
'API_ERROR_DNSSYNC_ADDITION' 2058
'API_ERROR_DNSSYNC_INVALID_ROLE' 2059
'API_ERROR_DNSSYNC_DELETION' 2060
'API_ERROR_DNSSYNC_NO_SUCH_HOST' 2061
'API_ERROR_DNSSYNC_NO_DATAFILE' 2062
'API_ERROR_DNSSYNC_EXPORT_ERROR' 2063
'API_ERROR_DNSSYNC_CLIENT_ERROR' 2064
'API_LICENSED_ACCOUNT_LIMIT_REACHED' 3000
'API_SLAVE_DOMAIN_LIMIT_REACHED' 3010
'API_ERROR_SLAVE_DOMAIN_EXISTS' 3011
'API_SLAVE_DOMAIN_INVALID_IP_TYPE' 3012
'API_POINTER_DOMAIN_LIMIT_REACHED' 3020
'API_ERROR_POINTER_DOMAIN_EXISTS' 3021
'API_ERROR_DOMAIN_ACTIVATION_FAILED' 3030
'API_ERROR_DOMAIN_EXISTS_ELSEWHERE' 3040
'API_ERROR_SYNCING_SERVERALIAS' 3050
'API_ERROR_SYNCING_VHOST' 3051