Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: ✉️ [APIM][DOCS] Adding Error Codes

...

Given below are some error codes and their meanings.

API handlers error codes

Error codeError MessageDescriptionExample
700700
API blockedThis API has been blocked temporarily. Please try again later or contact the system administrators.Invoke an API in the BLOCKED lifecycle state.
900800
Message throttled outThe 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.Invoke an API exceeding the tier limit.
900801
Hard limit exceededHard throttle limit has been reached.Invoke an API exceeding the hard throttle limit.
900802Resource level throttle outMessage is throttled out because resource level has exceeded.Sending/Receiving messages beyond authorized resource level.
900803Application level throttle outMessage is throttled out because application level is exceeded.Sending/Receiving messages beyond authorized application level.
900804Subscription level throttled outMessage throttled out
because
due to subscription level
exceeded
throttling limit reached.Sending/Receiving messages beyond
authorized
configured throttling limit of subscription level policy.
900805Message blockedAccessing
unauthorized resourcesInvoke
an API
resource with an authorized user role or subscription900806Custom policy throttled out
which is blocked on user, IP, application, or API Context.An admin user can block API invocations in real time by user, IP, application, or API context. The API invocation meets the blocked condition.
900806Custom policy throttled outMessage throttled out due to exceeding the
rules set in
limit configured through the custom throttling policy rules.
Invoke an API with a custom policy, by sending/receiving messages exceeding the authorized subscription/application level defined
The API invocations meet custom throttle policy rules, exceeding the limits of the configured custom policy.
900807Message
throttled outMessaged throttled out because the set burst control/rate limit (requests per second) has exceededSending/Receiving messages exceeding the authorized burst control/rate limit, in one second 
900900

Unclassified authentication failure

An unspecified error has occurred.Backend service for key validation is not accessible when trying to invoke an API
900901

Invalid credentials

Invalid authentication information provided.Using an older access token after an access token has been renewed.
900902

Missing credentials

No authentication information provided.Accessing an API without the Authorization: Bearer header
throttled outMessaged throttled out because of exceeding the burst control/rate limit (requests per second) in the subscription level policy.Sending/Receiving messages exceeding the configured burst control/rate limit within second.
900905

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 and user accesses tokens. See Access Tokens.

Invoke an API with application token, where the resource only allows application user tokens.
900906

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.Invoke an API resource that is not available.
900907

The requested API is temporarily blocked

Happens when the API user is blocked.Invoke API resource with a subscription that has been blocked by the API publisher.
900908

Resource forbidden

The user invoking the API has not been granted access to the required resource.Invoke an unsubscribed API.
900909

The subscription to the API is inactive

The status of the API has changed to an inaccessible/unavailable state.Invoke an API resource with a subscription that has not yet been approved by the administrator.
900910

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.

Invoke an API resource with an access token that is not generated to be used with the resource's scope.
102511Incomplete payloadThe payload sent with the request is too large and the client is unable to keep the connection alive until the payload is completely transferred to the API GatewaySending a large PDF file with the POST request.
Note

The error codes 900903 (Access token expired) and 900904 (Access token inactive) are deprecated from API Manager 1.9.0 onwards. Alternatively, error code 900901 will be sent when the token is invalid or inactive.

...