Policy error reference

This page applies to Apigeeand Apigee hybrid.

View Apigee Edge documentation.

AccessControl policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Fault variables

These variables are set when a runtime error occurs. For more information, see Variables specific to policy errors .

Example fault response

{
   "fault":{
     "faultstring":"Access Denied for client ip : 52.211.243.3"
      "detail":{
         "errorcode":"steps.accesscontrol.IPDeniedAccess"
      }
   }
}

Example fault rule

<FaultRule name="IPDeniedAccess">
    <Step>
        <Name>AM-IPDeniedAccess</Name>
        <Condition>(fault.name Matches "IPDeniedAccess") </Condition>
    </Step>
    <Condition>(acl.failed = true) </Condition>
</FaultRule>

AccessEntity policy

For related information, see What you need to know about policy errors and Handling faults .

Runtime errors

None.

Deployment errors

AssignMessage policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors .

Example error response

 { 
  
  
 "fault" 
 :{ 
  
  
 "detail" 
 :{ 
  
  
 "errorcode" 
 : 
 "steps.assignmessage.VariableOfNonMsgType" 
  
 }, 
  
 "faultstring" 
 : 
 "AssignMessage[AM-SetResponse]: value of variable is not of type Message" 
  
 } 
 } 

Example fault rule

< FaultRule 
  
 name 
 = 
 "Assign Message Faults" 
>  
< Step 
>  
< Name>AM 
 - 
 CustomNonMessageTypeErrorResponse 
< / 
 Name 
>  
< Condition 
> ( 
 fault 
 . 
 name 
  
 Matches 
  
 "VariableOfNonMsgType" 
 ) 
  
< / 
 Condition 
>  
< / 
 Step 
>  
< Step 
>  
< Name>AM 
 - 
 CustomSetVariableErrorResponse 
< / 
 Name 
>  
< Condition 
> ( 
 fault 
 . 
 name 
  
 = 
  
 "SetVariableFailed" 
 ) 
< / 
 Condition 
>  
< / 
 Step 
>  
< Condition 
> ( 
 assignmessage 
 . 
 failed 
  
 = 
  
 true 
 ) 
  
< / 
 Condition 
>
< / 
 FaultRule 
>

BasicAuthentication policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

 { 
  
  
 "fault" 
 :{ 
  
  
 "detail" 
 :{ 
  
  
 "errorcode" 
 : 
 "steps.basicauthentication.UnresolvedVariable" 
  
 }, 
  
 "faultstring" 
 : 
 "Unresolved variable : request.queryparam.password" 
  
 } 
 } 

Example fault rule

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

DecodeJWS policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring , because it could change.

Example fault rule

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

DecodeJWT policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring , because it could change.

Example fault rule

<FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "InvalidToken")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

ExtractVariables policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors .

Example error response

 { 
  
 "fault" 
 :{ 
  
 "detail" 
 :{ 
  
 "errorcode" 
 : 
 "steps.extractvariables.SourceMessageNotAvailable" 
  
 }, 
  
 "faultstring" 
 : 
 "request message is not available for ExtractVariable: EV-ParseJsonResponse" 
  
 } 
 } 

Example fault rule

< FaultRule 
  
 name 
 = 
 "Extract Variable Faults" 
>  
< Step 
>  
< Name>AM 
 - 
 CustomErrorMessage 
< / 
 Name 
>  
< Condition 
> ( 
 fault 
 . 
 name 
  
 = 
  
 "SourceMessageNotAvailable" 
 ) 
  
< / 
 Condition 
>  
< / 
 Step 
>  
< Condition 
> ( 
 extractvariables 
 . 
 EM 
 - 
 ParseJsonResponse 
 . 
 failed 
  
 = 
  
 true 
 ) 
  
< / 
 Condition 
>
< / 
 FaultRule 
>

GenerateJWS policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring , because it could change.

Example fault rule

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

GenerateJWT policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring , because it could change.

Example fault rule

<FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "InvalidToken")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

JavaCallout policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when the proxy containing the policy is deployed.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors .

Example error response

 { 
  
  
 "fault" 
 :{ 
  
  
 "faultstring" 
 : 
 "Failed to execute JavaCallout. [policy_name]" 
 , 
  
 "detail" 
 :{ 
  
  
 "errorcode" 
 : 
 "javacallout.ExecutionError" 
  
 } 
  
 } 
 } 

Example fault rule

< FaultRule 
  
 name 
 = 
 "JavaCalloutFailed" 
>  
< Step 
>  
< Name>AM 
 - 
 JavaCalloutError 
< / 
 Name 
>  
< / 
 Step 
>  
< Condition 
> ( 
 fault 
 . 
 name 
  
 Matches 
  
 "ExecutionError" 
 ) 
  
< / 
 Condition 
>
< / 
 FaultRule 
>

JavaScript policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors .

Example error response

 { 
  
 "fault" 
 : 
  
 { 
  
 "faultstring" 
 : 
  
 "Execution of SetResponse failed with error: Javascript runtime error: " 
 ReferenceError 
 : 
  
 "status" 
  
 is 
  
 not 
  
 defined 
 . 
  
 ( 
 setresponse 
 . 
 js 
 : 
 6 
 ) 
 \ 
 "" 
 , 
  
 "detail" 
 : 
  
 { 
  
 "errorcode" 
 : 
  
 "steps.javascript.ScriptExecutionFailed" 
  
 } 
  
 } 
 } 

Example fault rule

< FaultRule 
  
 name 
 = 
 "JavaScript Policy Faults" 
>  
< Step 
>  
< Name>AM 
 - 
 CustomErrorResponse 
< / 
 Name 
>  
< Condition 
> ( 
 fault 
 . 
 name 
  
 Matches 
  
 "ScriptExecutionFailed" 
 ) 
  
< / 
 Condition 
>  
< / 
 Step 
>  
< Condition 
> ( 
 javascript 
 . 
 JavaScript 
 - 
 1. 
 failed 
  
 = 
  
 true 
 ) 
  
< / 
 Condition 
>
< /FaultRule 
>

JSONThreatProtection policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

None.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors .

Example error response

{
  "fault": {
    "faultstring": "JSONThreatProtection[JPT-SecureRequest]: Execution failed. reason: JSONThreatProtection[JTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.jsonthreatprotection.ExecutionFailed"
    }
  }
}

Example fault rule

<FaultRule name="JSONThreatProtection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(jsonattack.JPT-SecureRequest.failed = true) </Condition>
</FaultRule>

The JSONThreatProtection policy types defines the following error codes:

JSONtoXML policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

None.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

{
  "fault": {
    "faultstring": "JSONToXML[JSON-to-XML-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.json2xml.SourceUnavailable"
    }
  }
}

Example fault rule

<FaultRule name="JSON To XML Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadJSON</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(jsontoxml.JSON-to-XML-1.failed = true) </Condition>
</FaultRule>

KeyValueMapOperations policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

MessageLogging policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

{  
   "fault":{
      "detail":{
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Example fault rule

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>

OASValidation policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors .

PopulateCache policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors .

Example error response

 { 
  
 "fault" 
 : 
  
 { 
  
 "faultstring" 
 : 
  
 "[entry] can not be cached. Only serializable entries are cached." 
 , 
  
 "detail" 
 : 
  
 { 
  
 "errorcode" 
 : 
  
 "steps.populatecache.EntryCannotBeCached" 
  
 } 
  
 } 
 } 

Example fault rule

<FaultRule name="Populate Cache Fault">
    <Step>
        <Name>AM-EntryCannotBeCached</Name>
        <Condition>(fault.name Matches "EntryCannotBeCached") </Condition>
    </Step>
    <Condition>(populatecache.POP-CACHE-1.failed = true) </Condition>
</FaultRule>

LookupCache policy

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults .

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

N/A

Example error response

N/A

InvalidateCache policy

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults .

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

N/A

Example error response

N/A

ResponseCache policy

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults .

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

N/A

Example error response

N/A

OAuthV2 policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

JWT token-specific runtime errors

Runtime error codes and descriptions for JWT auth token flows depend on the OAuth2 flow context:

• If the flow context is token generation or refresh, see Error codes for JWT token generation and refresh flows below.
• For the token verification flow, see Error codes for token verification flows below.

Error codes for JWT token generation and refresh flows

For OAuth2 flows that generate or refresh JWT tokens, error responses adhere to the error responses specified in RFC6749. For details, see Section 5.2 Error Response .

Error codes for the token verification flow

The error codes listed in the following table apply to VerifyAccessToken operation only.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

JWT token-specific deployment errors

These deployment errors are specific to policies that use JWT token operations.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

These responses are sent back to the client if the <GenerateResponse> element is true .

If <GenerateResponse> is true , the policy returns errors in this format for operations that generate tokens and codes. For a complete list, see see OAuth HTTP error response reference .

{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}

If <GenerateResponse> is true , the policy returns errors in this format for verify and validate operations. For a complete list, see see OAuth HTTP error response reference .

 { 
 { 
 "fault" 
 : 
 { 
 "faultstring" 
 : 
 "Invalid Access Token" 
 , 
 "detail" 
 : 
 { 
 "errorcode" 
 : 
 "keymanagement.service.invalid_access_token" 
 } 
 } 
 } 

Example fault rule

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientResponse</Name>
        <Condition>(fault.name = "invalid_client") OR (fault.name = "InvalidClientIdentifier")</Condition>
    </Step>
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

GetOAuthV2Info policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes. The error names shown below are the strings that are assigned to the fault.name variable when an error occurs. See the Fault variables section below for more details.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

 { 
 "fault" 
 : 
 { 
 "faultstring" 
 : 
 "ClientId is Invalid" 
 , 
 "detail" 
 : 
 { 
 "errorcode" 
 : 
 "keymanagement.service.invalid_client-invalid_client_id" 
 } 
 } 
 } 

Example fault rule

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

SetOAuthV2Info policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

DeleteOAuthV2Info policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

PythonScript policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors .

Example error response

 { 
 "fault" 
 : 
 { 
 "faultstring" 
 : 
 "Execution of SetResponse failed with error: Pythonscript runtime error: " 
 ReferenceError 
 : 
 "status" 
 is 
 not 
 defined 
 . 
\ "" 
 , 
 "detail" 
 : 
 { 
 "errorcode" 
 : 
 "steps.script.ScriptExecutionFailed" 
 } 
 } 
 } 

Example fault rule

< FaultRule 
 name 
 = 
 "PythonScript Policy Faults" 
>
    < Step 
>
        < Name>AM 
 - 
 CustomErrorResponse 
< / 
 Name 
>
        < Condition 
> ( 
 fault 
 . 
 name 
 Matches 
 "ScriptExecutionFailed" 
 ) 
< / 
 Condition 
>
    < / 
 Step 
>
    < Condition 
> ( 
 pythonscript 
 . 
 PythonScript 
 - 
 1. 
 failed 
 = 
 true 
 ) 
< / 
 Condition 
>
< / 
 FaultRule 
>

Quota policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors .

Example error response

 { 
 "fault" 
 : 
 { 
 "detail" 
 : 
 { 
 "errorcode" 
 : 
 "policies.ratelimit.QuotaViolation" 
 } 
 , 
 "faultstring" 
 : 
 "Rate limit quota violation. Quota limit  exceeded. Identifier : _default" 
 } 
 } 

Example fault rule

<FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "QuotaViolation") </Condition>
        </Step>
        <Condition>ratelimit.Quota-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

ResetQuota policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

RaiseFaultpolicy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

None.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

 { 
  
 "fault" 
 :{ 
  
 "detail" 
 :{ 
  
 "errorcode" 
 : 
 "steps.raisefault.RaiseFault" 
  
 } 
 , 
  
 "faultstring" 
 : 
 "Raising fault. Fault name: [name]" 
  
 } 
 } 

RegularExpressionProtection policy

This section describes the error codes and messages returned and fault variables set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. If you want to capture an error and raise your own custom error, set the continueOnError="true" attribute on the policy root element. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors .

SAMLAssertion policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

 { 
  
 "fault" 
 : 
  
 { 
  
 "faultstring" 
 : 
  
 "GenerateSAMLAssertion[GenSAMLAssert]: Invalid media type" 
 , 
  
 "detail" 
 : 
  
 { 
  
 "errorcode" 
 : 
  
 "steps.saml.generate.InvalidMediaTpe" 
  
 } 
  
 } 
 } 

Example fault rule

<FaultRules>
    <FaultRule name="invalid_saml_rule">
        <Step>
            <Name>invalid-saml</Name>
        </Step>
        <Condition>(GenerateSAMLAssertion.failed = "true")</Condition>
    </FaultRule>
</FaultRules>

ServiceCallout policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Deployment of \"organizations/foo/apis/apiproxy/revisions/1\" requires a service
          account identity, but one was not provided with the request.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

 { 
  
 "fault" 
 :{ 
  
 "detail" 
 :{ 
  
 "errorcode" 
 : 
 "steps.servicecallout.RequestVariableNotMessageType" 
  
 } 
 , 
  
 "faultstring" 
 : 
 "ServiceCallout[ServiceCalloutGetMockResponse]: 
 request variable data_str value is not of type Message" 
  
 } 
 } 

Example fault rule

<FaultRule name="RequestVariableNotMessageType">
    <Step>
        <Name>AM-RequestVariableNotMessageType</Name>
    </Step>
    <Condition>(fault.name = "RequestVariableNotMessageType")</Condition>
</FaultRule>

SOAPMessageValidation policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

SpikeArrest policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

Shown below is an example error response:

 { 
 "fault" 
 : 
 { 
 "detail" 
 : 
 { 
 "errorcode" 
 : 
 "policies.ratelimit.SpikeArrestViolation" 
 } 
 , 
 "faultstring" 
 : 
 "Spike arrest violation. Allowed rate : 10ps" 
 } 
 } 

Example fault rule

Shown below is an example fault rule to handle a SpikeArrestViolation fault:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

VerifyAPIKey policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error responses

{  
   "fault":{  
      "faultstring":"Invalid ApiKey",
      "detail":{  
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{  
   "fault":{  
      "detail":{  
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

Example fault rule

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

VerifyIAM policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

This policy does not return any policy-specific deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

VerifyJWS policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring , because it could change.

Example fault rule

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

VerifyJWT policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring , because it could change.

Example fault rule

<FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "InvalidToken")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

XMLThreatProtection policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

None.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

 { 
 "fault": { 
 "faultstring": "XMLThreatProtection[XPT-SecureRequest]: Execution failed. reason: XMLThreatProtection[XTP-SecureRequest]: Exceeded object entry name length at line 2", 
 "detail": { 
 "errorcode": "steps.xmlthreatprotection.ExecutionFailed" 
 } 
 } 
 } 

Example fault rule

<FaultRule name="XML Threat Protection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(xmlattack.XPT-SecureRequest.failed = true) </Condition>
</FaultRule>

XMLtoJSON policy

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults .

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors .

Example error response

 { 
 "fault": { 
 "faultstring": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available", 
 "detail": { 
 "errorcode": "steps.xml2json.SourceUnavailable" 
 } 
 } 
 } 

Example fault rule

< faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="XML to JSON Faults"> 
 <Step> 
 <Name>AM-SourceUnavailableMessage</Name> 
 <Condition>(fault.name Matches "SourceUnavailable") </Condition> 
 </Step> 
 <Step> 
 <Name>AM-BadXML</Name> 
 <Condition>(fault.name = "ExecutionFailed")</Condition> 
 </Step> 
 <Condition>(xmltojson.XMLtoJSON-1.failed = true) </Condition> 
< /FaultRule 
>

XSLTransform policy

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.