Fault codes

This page applies to Apigeeand Apigee hybrid.

View Apigee Edge documentation.

Apigee provides a set of fault codes for various features that help you to diagnose issues. For example, a typical 4xx or 5xx HTTP status code can be classified using one or more fault codes.

Fault codes provide you with useful information about runtime errors, including information about the source and name of the error in the following format: [prefix].[error_name]

For example: steps.raisefault.RaiseFault

In this example:

  • steps.raisefault is the prefix that indicates the RaiseFault policy generated the error.
  • RaiseFault is the error name that helps you determine the cause of the error. In this case, more information would be provided by the fault string.

The following table summarizes the fault codes, organized by category and sub-category.

Category
Sub-category
Name
Fault Code

API protocol

HTTP

HTTP BadFormData
protocol.http.BadFormData
HTTP BadRequestPath
protocol.http.BadPath
HTTP DuplicateHeader
protocol.http.DuplicateHeader
HTTP EmptyHeaderName
protocol.http.EmptyHeaderName
HTTP HeaderNameWithNonASCIICharacter
protocol.http.HeaderNameWithNonAsciiChar
HTTP HeaderWithInvalidCharacter
protocol.http.HeaderWithInvalidChar
HTTP InvalidRequestPath
protocol.http.InvalidPath
HTTP LengthRequired
messaging.adaptors.http.flow.LengthRequired
HTTP ProxyTunnelCreationFailed
protocol.http.ProxyTunnelCreationFailed
HTTP RequestHasABigBody
HTTP RequestsHaveABigLine
protocol.http.TooBigLine
HTTP Response306IsReserved
protocol.http.Response306Reserved
HTTP Response405WithoutAllowHeader
protocol.http.Response405WithoutAllowHeader
ResponseWithBodyForIncorrectStatusCode
protocol.http.ResponseWithBody
HTTP TargetURLHasEmptyPath
protocol.http.EmptyPath
HTTP TooBigHeaders
protocol.http.TooBigHeaders
HTTP UnsupportedEncoding
protocol.http.UnsupportedEncoding

Developer/app

Key Management

KeyManagement AccessTokenNotApproved
keymanagement.service.access_token_not_approved
KeyManagement APIProductNotFound
keymanagement.service.InvalidAPICallAsNoApiProductMatchFound
KeyManagement AppNotApproved
keymanagement.service.invalid_client-app_not_approved
KeyManagement AppNotApproved
keymanagement.service.app_not_approved
KeyManagement AuthorizationCodeExpired
keymanagement.service.access_denied-authorization_code_expired
KeyManagement AuthorizationCodeinvalid
keymanagement.service.invalid_request-authorization_code_invalid
KeyManagement ClientIDAuthorizationCodeMismatch
keymanagement.service.invalid_client-client_id_authorzation_code_mismatch
KeyManagement ClientIDNotApproved
keymanagement.service.invalid_client-client_id_not_approved
KeyManagement CompanyStatusNotActive
keymanagement.service.CompanyStatusNotActive
KeyManagement Consumer Key Expired
keymanagement.service.consumer_key_expired
KeyManagement DeveloperNotActive
keymanagement.service.DeveloperStatusNotActive
KeyManagement InvalidAccessToken
keymanagement.service.oauth10_access_token_doesnotexist
KeyManagement InvalidClientID
keymanagement.service.InvalidClientIdForGivenResource
KeyManagement InvalidClientID
keymanagement.service.invalid_client-client_id_authorzation_code_mismatch
KeyManagement InvalidClientID
keymanagement.service.invalid_client-invalid_client_id
KeyManagement InvalidConsumerKey
keymanagement.service.invalid_consumer_key
KeyManagement InvalidRefreshToken
keymanagement.service.invalid_refresh_token
KeyManagement RefreshTokenExpired
keymanagement.service.refresh_token_expired

Extension Policy

JavaCallout

JavaCallout errorname

JavaScript Callout

JavaScriptCallout errorname

MessageLogging

MessageLogging StepDefinitionExecutionFailed
steps.messagelogging.StepDefinitionExecutionFailed

Node Script

NodeScript ExecutionError
scripts.node.ScriptExecutionError

PythonScript

PythonScript errorname

Script

Script EvaluationFailed
steps.script.ScriptEvaluationFailed

ServiceCallout

ServiceCallout errorname

Gateway

Proxy

Gateway APITimedOut
flow.APITimedOut
Gateway ApplicationNotFound
messaging.adaptors.http.flow.ApplicationNotFound
Gateway DecompressionFailureAtRequest
messaging.adaptors.http.flow.DecompressionFailureAtRequest
Gateway DecompressionFailureAtResponse
messaging.adaptors.http.flow.DecompressionFailureAtResponse
Gateway KeyAliasNotFound
security.util.KeyAliasNotFound
Gateway RouteToTargetFailed
messaging.runtime.RouteFailed
Gateway SharedFlowNotFound
flow.SharedFlowNotFound
Gateway TargetIsMissing
messaging.runtime.TargetMissing

Target

Gateway FailedHandshakeWithTargetEndpoint
messaging.adaptors.http.flow.SslHandshakeFailed
Gateway TimeoutWithTargetOrCallout
messaging.adaptors.http.flow.GatewayTimeout
Gateway TargetOrCalloutEndpointsNotAvailable
messaging.adaptors.http.flow.ServiceUnavailable
Gateway TargetServerConfiguredInLoadBalancerIsDown
messaging.adaptors.http.flow.NoActiveTargets
Gateway UnexpectedEOFAtTarget
messaging.adaptors.http.flow.UnexpectedEOFAtTarget

Virtual Host

VirtualHost InvalidKeystoreOrTrustStore
messaging.runtime.SecurityStoreNotConfigured
VirtualHost SecurityStoreNotConfigured
messaging.runtime.SecurityStoreNotConfigured

Other

Gateway HTTPErrorResponseCode
messaging.adaptors.http.flow.ErrorResponseCode

Mediation Policy

AssignMessage

AssignMessage errorname

ExtractVariables

ExtractVariables errorname

JSONtoXML

JSONtoXML errorname

KeyValueMap

KeyValueMap errorname

MessageValidation

MessageValidation errorname

RaiseFault

RaiseFault RaiseFaultException
steps.raisefault.RaiseFault

XMLtoJSON

XMLtoJSON errorname

XSLTransformation

XSLTransformation errorname

Monetization

Mint UndefinedProduct
mintstep.undefinedProduct

Security Policy

AccessControl

AccessControl errorname

BasicAuthentication

BasicAuthentication errorname

JSONThreatProtection

JSONThreatProtection errorname

JWT

JWT errorname

OAuth

OAuth errorname

Regex Protection

RegexProtection errorname

SAMLAssertion

SAMLAssertion InvalidKeyStore
steps.saml.generate.InvalidKeyStore
SAMLAssertion InvalidMediaType
steps.saml.generate.InvalidMediaTpe
SAMLAssertion InvalidTrustStore
steps.saml.validate.InvalidTrustStore
SAMLAssertion SAMLAssertionForNotBeforeConditionViolated
steps.saml.validate.NotBeforeConditionViolated
SAMLAssertion SignatureValidationFailed
steps.saml.validate.SignatureValidationFailed
SAMLAssertion XPathResolutionFailed
steps.saml.validate.XPathResolutionFailed

XMLThreatProtection

XMLThreatProtection errorname

Sense

Sense

Sense RaiseFault
messaging.runtime.SenseRaiseFault

Traffic Mgmt Policy

Caching

Caching InvalidExpiryDatForCacheEntry
messaging.config.beans.InvalidExpiryDateForCacheEntry

ConcurrentRateLimit

ConcurrentRateLimit ConcurrentRateLimitViolation
policies.concurrentratelimit.ConcurrentRatelimitViolation

Quota

Quota errorname

Quota or SpikeArrest

QuotaOrSpikeArrest InvalidMessageWeight

ResetQuota

ResetQuota errorname

SpikeArrest

SpikeArrest errorname
Create a Mobile Website
View Site in Mobile | Classic
Share by: