Fault code reference

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.

Note: When setting up alerts, fault codes are organized by category and subcategory, and display the human-readable name. When comparing relational activity between metrics, the raw fault codes are displayed.

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 protocol.http.TooBigBody
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 Java Callout JavaCallout errorname See Java Callout policy runtime errors
JavaScript Callout JavaScriptCallout errorname See JavaScript policy runtime errors
Message Logging MessageLogging StepDefinitionExecutionFailed steps.messagelogging.StepDefinitionExecutionFailed
Node Script NodeScript ExecutionError scripts.node.ScriptExecutionError
Script Script EvaluationFailed steps.script.ScriptEvaluationFailed
Service Callout ServiceCallout errorname See Service Callout policy runtime errors
Gateway Proxy Gateway APITimedOut flow.APITimedOut
Gateway CircularReferenceForCountLimit messaging.adaptors.http.flow.CircularRefCountLimit
Gateway DecompressionFailureAtRequest messaging.adaptors.http.flow.DecompressionFailureAtRequest
Gateway DecompressionFailureAtResponse messaging.adaptors.http.flow.DecompressionFailureAtResponse
Gateway InvalidValueForExpiresIn messaging.config.beans.InvalidValueForExpiresIn
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
Gateway UnresolvedVariable messaging.runtime.UnresolvedVariable
Mediation Policy Assign Message AssignMessage errorname See Assign Message policy runtime errors
Extract Variables ExtractVariables errorname See Extract Variables policy runtime errors
JSON to XML JSONtoXML errorname See JSON to XML policy runtime errors
Key Value Map KeyValueMap errorname See Key Value Map Operations policy runtime errors
Message Validation MessageValidation errorname See SOAP Message Validation policy runtime errors
Raise Fault RaiseFault RaiseFaultException steps.raisefault.RaiseFault
XML to JSON XMLtoJSON errorname See XML to JSON policy runtime errors
Monetization Mint UndefinedProduct mintstep.undefinedProduct
Security Policy Access Control AccessControl errorname See Access Control policy runtime errors
Basic Authentication BasicAuthentication errorname See Basic Authentication policy runtime errors
JSON Threat Protection JSONThreatProtection errorname See JSON Threat Protection policy runtime errors
JWT JWT errorname See JWT policy runtime errors
OAuth OAuth errorname See OAuth V2 policy runtime errors
Regex Protection RegexProtection errorname See Regular Expression Protection policy runtime errors
SAML Assertion 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
XML Threat Protection XMLThreatProtection errorname See XML Threat Protection policy runtime errors
Sense Sense Sense RaiseFault messaging.runtime.SenseRaiseFault
Traffic Mgmt Policy Caching Caching InvalidExpiryDatForCacheEntry messaging.config.beans.InvalidExpiryDateForCacheEntry
Concurrent Rate Limit ConcurrentRateLimit ConcurrentRateLimitViolation policies.concurrentratelimit.ConcurrentRatelimitViolation
Quota Quota errorname See Quota policy runtime errors
Quota or Spike Arrest QuotaOrSpikeArrest InvalidMessageWeight policies.ratelimit.InvalidMessageWeight
Reset Quota ResetQuota errorname See Reset Quota policy runtime errors
Spike Arrest SpikeArrest errorname See Spike Arrest policy runtime errors