Troubleshooting Web API

Issues with the Web API are usually because of:

  • Incorrect configuration. For example, when you enter an incorrect URL or do not authorize the client to use the Web API.

  • Incorrect command syntax, such as missing parameters or invalid parameter values.

For standard requests:

If the request fails, the JSON response body includes a code field, and the message field includes a textual description.

  • The message field - Shows success of the procedure.

  • The code field - Implies that the procedure failed.

For bulk requests, the HTTP status code is always 200. A granular error code is given for each of the requests.

Statuses and Responses

HTTP status

API response ("code" field)

Possible cause

N/A

N/A

No response is usually the result of a connectivity issue. Make sure the API client can get an access to the gateway and that the gateway does not drop the traffic.

404

N/A

This is the result of these causes:

  • Identity Awareness API is disabled.

  • Identity Awareness API is enabled, but the API client is not authorized.

  • Identity Awareness API is enabled, but the IDA API access settings do not permit access from the API client network.

  • Incorrect or missing shared secret.

  • Incorrect URL.

500

GENERIC_ERROR_INVALID_SYNTAX

Syntax error in the JSON request body (for example: redundant comma after the last parameter).

500

GENERIC_ERROR_INVALID_PARAMETER_NAME

The request includes a field that is not permitted for this request.

500

GENERIC_ERR_MISSING_REQUIRED_PARAMETERS

Missing mandatory parameter.

500

GENERIC_ERR_INVALID_PARAMETER

Incorrect parameter value or parameter type (for example: invalid IP address).

500

GENERIC_INTERNAL_ERROR

Internal error on the gateway. Contact Check Point Support.