This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Error Handling - API Manager 1.8.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

When errors/exception occur in the system, the API Manager throws XML-based error responses by default. To change the format of the error response that is sent to the client, you change the auth failure handler in the <AM_HOME>/repository/deployment/server/synapse-configs/default/sequences/_auth_failure_handler.xml file. Given below is the default configuration:

<sequence name="auth_failure_handler"> <property name="error_message_type" value="application/xml"/> <sequence key="build"/> </sequence>

If you change application/xml to something like applicatoin/json, the error response will be sent in JSON format.

Given below are some error codes and their meanings.

API handlers error codes

Error codeError MessageDescription

Unclassified Authentication Failure

An unspecified error has occurred

Invalid Credentials

Invalid Authentication information provided

Missing Credentials

No authentication information provided

Access Token Expired

Access Token has expired. Renew the access token.

Access Token Inactive

Access token has become inactive. Generate new access token.

Incorrect Access Token Type is provided

The access token type used is not supported when invoking the API. The supported access token types are Application Accesses Token and User Accesses Token. See Access Tokens.


No matching resource found in the API for the given request

A resource with the name in the request can not be found in the API.

The requested API is temporarily blocked

The status of the API has been changed to an inaccessible/unavailable state.

Resource forbidden

The user invoking the API has not been granted access to the required resource.

The subscription to the API is inactive

Happens when the API user is blocked.

The access token does not allow you to access the requested resource

Can not access the required resource with the provided access token. Check the valid resources that can be accessed with this token.

Message throttled out

The maximum number of requests that can be made to the API within a designated time period is reached and the API is throttled for the user.


API blocked

This API has been blocked temporarily. Please try again later or contact the system administrators.

Sequences error codes

Error codeDescription
Production/sandbox key offered to the API with no production/sandbox endpoint
No matching resource found in the API for the given request

In addition to the above error codes, we have engaged Synapse-level error codes to the default fault sequence and custom fault sequences (e.g.,_token_fault_.xml) of the API Manager. For information, see Error Handling in WSO2 ESB documentation.

  • No labels