List of Error Codes for SonicOS API Calls

SonicOS API provides an alternative to the SonicOS Command Line Interface (CLI) for configuring various functions.

NOTE: To configure SonicOS API please find the link : Introduction to SonicOS API 

Listed below are the error codes in SonicOS that you may encounter while using SonicOS.

/* 200 - OK */

• E_OK: "Success."
• E_WARNING: "Warning." Usually will have detail warning message in message field
• E_NO_CHANGE: "No changes made."
• E_CANCEL: "Cancelled."
• E_USER_CANCELLED: "User Cancelled."
• E_EXIT_LOGOUT: "User logout."
• E_EXT_TERMINATE: "Session terminated."
• E_POLICYBANNER_CANCELED: "Aborting login - policy banner was not accepted."
• E_TEST_FAILED: "The test result was a failure."

/* 400 - Bad Request */

• E_INVALID_API_CALL: "Invalid API call."
• E_INVALID_FXN_ARG: "Invalid API argument."
• E_EXISTS: "Already exists."
• E_NO_MATCH: "No matching command found."
• E_AMBIGUOUS_CMD: "Ambiguous command."
• E_AMBIGUOUS_PARAM: "Ambiguous parameter."
• E_SYNTAX: "Invalid input detected."
• E_INCOMPLETE_CMD: "Incomplete command."
• E_EXTRA_TEXT: "Extra text detected."
• E_RANGE: "Out of bounds condition."
• E_ACCESS_DENIED: "SSLVPN login is disabled or not from SSLVPN port."
• E_ERROR: "Error." Usually will have detail error message in message field

/* 401 - Unauthorized */

• E_UNAUTHORIZED: "Unauthorized."
• E_MAX_LOGIN_ATTEMPTS: "Maximum login attempts exceeded."
• E_USER_LOCKOUT: "User is locked out."
• E_REQUIRE_CLIENT_CERT: "Require client certification login."
• E_NO_CLIENT_CERT: "Client certification login not supported."

/* 403 - Forbidden */

• E_ACCESS_DENIED: "Access denied."
• E_DISABLED: "Service is disabled."

/* 404 - NOT FOUND */

• E_NOT_FOUND: "Not found."
• E_ERROR: "Not found"
  
  

/* 405 - METHOD NOT ALLOWED */

• E_DISABLED: "Feature is currently disabled."
• E_UNLICENSED: "Licensing must be activated for this feature."
• E_HA_IDLE: "Idle firewall can not be configured."
• E_READ_ONLY: "Read only."
• E_NON_CONFIG: "Non config mode."
• E_INVALID_API_CALL: "API does not support the method requested."
• E_ERROR: "Not allowed in current mode"

/* 406  -  NOT ACCEPTABLE */

• E_INVALID_API_CA: "API does not support the content type requested."

/* 413  -  Payload Too Large */

• E_TOO_BIG: "Maximum size of the request body was exceeded."

/* 414  -  URI Too Long */

• E_INVALID_API_CALL: "API endpoint is too long."

/* 500 - Internal Server Error */

• E_ERROR: "Internal Error." Usually will have detail error message in message field
• E_TIME_OUT: "Session timed out."
• E_LOST_CONN: "Lost connection."
• E_PIPE_TIME_OUT: "CLI pipe execute script timed out."
• E_OUT_OF_MEM: "Out of memory."
• E_NOT_FOUND: "Unable to access Open API specification."

/* 503 - Service Unavailable */

• E_OUT_OF_MEM: "Out of memory."
• E_ACCESS_DENIED: "Connection not allowed: reached maximum number of sessions."