The policy playbooks provide detailed troubleshooting information for runtime and
deployment errors associated with Apigee policies.
Playbooks for policy runtime errors
Runtime errors are errors that can occur while a policy executes in the context
of an API proxy flow. When a runtime error occurs, the proxy flow enters the error
state, and you need to diagnose and fix the problem and redeploy the proxy.
Apigee currently provides policy runtime error playbooks for these policies:
Deployment errors occur when you deploy your proxy and Apigee determines a policy
is not configured correctly. Deployment stops, and you need to debug and
fix the problem before you can deploy the proxy.
Apigee currently provides policy deployment error playbooks for these policies:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis documentation provides troubleshooting playbooks for both Apigee and Apigee hybrid environments.\u003c/p\u003e\n"],["\u003cp\u003eThe playbooks cover two main categories of errors: runtime errors, which occur during policy execution, and deployment errors, which happen when a proxy is deployed.\u003c/p\u003e\n"],["\u003cp\u003eRuntime error playbooks are available for 16 different policies, helping users diagnose and fix issues that occur when a policy executes.\u003c/p\u003e\n"],["\u003cp\u003eDeployment error playbooks are provided for 20 specific policies, assisting users in debugging and resolving problems that prevent successful proxy deployment.\u003c/p\u003e\n"],["\u003cp\u003eThe linked content directs users to Apigee Edge documentation should they need it.\u003c/p\u003e\n"]]],[],null,["# Introduction to Policy Playbooks\n\n*You're viewing **Apigee** and **Apigee hybrid** documentation.\nView [Apigee Edge](https://docs.apigee.com/api-platform/troubleshoot/policies/introduction) documentation.*\n\nThe policy playbooks provide detailed troubleshooting information for runtime and\ndeployment errors associated with Apigee policies.\n\nPlaybooks for policy runtime errors\n-----------------------------------\n\nRuntime errors are errors that can occur while a policy executes in the context\nof an API proxy flow. When a runtime error occurs, the proxy flow enters the error\nstate, and you need to diagnose and fix the problem and redeploy the proxy.\n\nApigee currently provides policy runtime error playbooks for these policies:\n\n- [AssignMessage](/apigee/docs/api-platform/troubleshoot/policies/runtime/assign-message-runtime-errors)\n- [BasicAuthentication](/apigee/docs/api-platform/troubleshoot/policies/runtime/basic-authentication-runtime-errors)\n- [ExtractVariables](/apigee/docs/api-platform/troubleshoot/policies/runtime/extract-variables-runtime-errors)\n- [FlowCallout](/apigee/docs/api-platform/troubleshoot/policies/runtime/flowcallout-runtime-errors)\n- [JavaScript](/apigee/docs/api-platform/troubleshoot/policies/runtime/javascript-runtime-errors)\n- [JSONThreatProtection](/apigee/docs/api-platform/troubleshoot/policies/runtime/jsonthreatprotection-errors)\n- [JSONtoXML](/apigee/docs/api-platform/troubleshoot/policies/runtime/jsontoxml-runtime-errors)\n- [KeyValueMapOperations](/apigee/docs/api-platform/troubleshoot/policies/runtime/key-value-map-runtime-errors)\n- [PythonScript](/apigee/docs/api-platform/troubleshoot/policies/runtime/python-script-runtime-errors)\n- [Quota](/apigee/docs/api-platform/troubleshoot/policies/runtime/quota-runtime-errors)\n- [ResetQuota](/apigee/docs/api-platform/troubleshoot/policies/runtime/reset-quota-runtime-errors)\n- [ServiceCallout](/apigee/docs/api-platform/troubleshoot/policies/runtime/service-callout-runtime-errors)\n- [SpikeArrest](/apigee/docs/api-platform/troubleshoot/policies/runtime/spike-arrest-runtime-errors)\n- [XMLThreatProtection](/apigee/docs/api-platform/troubleshoot/policies/runtime/xmlthreatprotection-runtime-errors)\n- [XMLtoJSON](/apigee/docs/api-platform/troubleshoot/policies/runtime/xmltojson-runtime-errors)\n- [XSLTransform](/apigee/docs/api-platform/troubleshoot/policies/runtime/xsl-transform-runtime-errors)\n\nPlaybooks for policy deployment errors\n--------------------------------------\n\nDeployment errors occur when you deploy your proxy and Apigee determines a policy\nis not configured correctly. Deployment stops, and you need to debug and\nfix the problem before you can deploy the proxy.\n\nApigee currently provides policy deployment error playbooks for these policies:\n\n- [AssignMessage](/apigee/docs/api-platform/troubleshoot/policies/deployment/assign-message-deployment-errors)\n- [BasicAuthentication](/apigee/docs/api-platform/troubleshoot/policies/deployment/basic-authentication-deployment-errors)\n- [ExtractVariables](/apigee/docs/api-platform/troubleshoot/policies/deployment/extract-variables-deployment-errors)\n- [InvalidateCache](/apigee/docs/api-platform/troubleshoot/policies/deployment/invalidate-cache-deployment-errors)\n- [JavaScript](/apigee/docs/api-platform/troubleshoot/policies/deployment/javascript-deployment-errors)\n- [KeyValueMapOperations](/apigee/docs/api-platform/troubleshoot/policies/deployment/key-value-map-deployment-errors)\n- [LookupCache](/apigee/docs/api-platform/troubleshoot/policies/deployment/lookup-cache-deployment-errors)\n- [MessageLogging](/apigee/docs/api-platform/troubleshoot/policies/deployment/message-logging-deployment-errors)\n- [PopulateCache](/apigee/docs/api-platform/troubleshoot/policies/deployment/populate-cache-deployment-errors)\n- [PythonScript](/apigee/docs/api-platform/troubleshoot/policies/deployment/python-script-deployment-errors)\n- [Quota](/apigee/docs/api-platform/troubleshoot/policies/deployment/quota-deployment-errors)\n- [RegularExpressionProtection](/apigee/docs/api-platform/troubleshoot/policies/deployment/regular-expression-protection-deployment-errors)\n- [ResetQuota](/apigee/docs/api-platform/troubleshoot/policies/deployment/reset-quota-deployment-errors)\n- [ResponseCache](/apigee/docs/api-platform/troubleshoot/policies/deployment/responsecache-deployment-errors)\n- [SAMLAssertion](/apigee/docs/api-platform/troubleshoot/policies/deployment/samlassertion-deployment-errors)\n- [ServiceCallout](/apigee/docs/api-platform/troubleshoot/policies/deployment/service-callout-deployment-errors)\n- [SpikeArrest](/apigee/docs/api-platform/troubleshoot/policies/deployment/spike-arrest-deployment-errors)\n- [StatisticsCollector](/apigee/docs/api-platform/troubleshoot/policies/deployment/stats-collector-deployment-errors)\n- [XMLtoJSON](/apigee/docs/api-platform/troubleshoot/policies/deployment/xmltojson-deployment-errors)\n- [XSLTransform](/apigee/docs/api-platform/troubleshoot/policies/deployment/xsl-transform-deployment-errors)"]]