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.- For policy errors, error-specific flow variables are populated that are useful for fault handling. See What you need to know about policy errors .
- When setting up alerts , fault codes are organized by category and subcategory, and display the human-readable name. When using the Investigate dashboard, the raw fault codes are displayed.
The following table summarizes the fault codes, organized by category and sub-category.
API protocol
HTTP
protocol.http.BadFormData
protocol.http.BadPath
protocol.http.DuplicateHeader
protocol.http.EmptyHeaderName
protocol.http.HeaderNameWithNonAsciiChar
protocol.http.HeaderWithInvalidChar
protocol.http.InvalidPath
messaging.adaptors.http.flow.LengthRequired
protocol.http.ProxyTunnelCreationFailed
protocol.http.TooBigLine
protocol.http.Response306Reserved
protocol.http.Response405WithoutAllowHeader
protocol.http.ResponseWithBody
protocol.http.EmptyPath
protocol.http.TooBigHeaders
protocol.http.UnsupportedEncoding
Developer/app
Key Management
keymanagement.service.access_token_not_approved
keymanagement.service.InvalidAPICallAsNoApiProductMatchFound
keymanagement.service.invalid_client-app_not_approved
keymanagement.service.app_not_approved
keymanagement.service.access_denied-authorization_code_expired
keymanagement.service.invalid_request-authorization_code_invalid
keymanagement.service.invalid_client-client_id_authorzation_code_mismatch
keymanagement.service.invalid_client-client_id_not_approved
keymanagement.service.CompanyStatusNotActive
keymanagement.service.consumer_key_expired
keymanagement.service.DeveloperStatusNotActive
keymanagement.service.oauth10_access_token_doesnotexist
keymanagement.service.InvalidClientIdForGivenResource
keymanagement.service.invalid_client-client_id_authorzation_code_mismatch
keymanagement.service.invalid_client-invalid_client_id
keymanagement.service.invalid_consumer_key
keymanagement.service.invalid_refresh_token
keymanagement.service.refresh_token_expired
MessageLogging
steps.messagelogging.StepDefinitionExecutionFailed
Node Script
scripts.node.ScriptExecutionError
Script
steps.script.ScriptEvaluationFailed
Gateway
Proxy
flow.APITimedOut
messaging.adaptors.http.flow.ApplicationNotFound
messaging.adaptors.http.flow.DecompressionFailureAtRequest
messaging.adaptors.http.flow.DecompressionFailureAtResponse
security.util.KeyAliasNotFound
messaging.runtime.RouteFailed
flow.SharedFlowNotFound
messaging.runtime.TargetMissing
Target
messaging.adaptors.http.flow.SslHandshakeFailed
messaging.adaptors.http.flow.GatewayTimeout
messaging.adaptors.http.flow.ServiceUnavailable
messaging.adaptors.http.flow.NoActiveTargets
messaging.adaptors.http.flow.UnexpectedEOFAtTarget
Virtual Host
messaging.runtime.SecurityStoreNotConfigured
messaging.runtime.SecurityStoreNotConfigured
Other
messaging.adaptors.http.flow.ErrorResponseCode
RaiseFault
steps.raisefault.RaiseFault
Monetization
mintstep.undefinedProduct
SAMLAssertion
steps.saml.generate.InvalidKeyStore
steps.saml.generate.InvalidMediaTpe
steps.saml.validate.InvalidTrustStore
steps.saml.validate.NotBeforeConditionViolated
steps.saml.validate.SignatureValidationFailed
steps.saml.validate.XPathResolutionFailed
Sense
Sense
messaging.runtime.SenseRaiseFault
Traffic Mgmt Policy
Caching
messaging.config.beans.InvalidExpiryDateForCacheEntry
ConcurrentRateLimit
policies.concurrentratelimit.ConcurrentRatelimitViolation