Jump To Close Expand all Collapse all Table of contents Administering the API Gateway Preface 1. Operating APIcast Expand section "1. Operating APIcast" Collapse section "1. Operating APIcast" 1.1. Mapping rules Expand section "1.1. Mapping rules" Collapse section "1.1. Mapping rules" 1.1.1. Matching of mapping rules 1.1.2. Mapping rules workflow 1.2. Host header 1.3. Production deployment 1.4. Public Base URL 1.5. Protecting your API backend 1.6. Using APIcast with private APIs 1.7. Configuring APIcast with OpenTracing Expand section "1.7. Configuring APIcast with OpenTracing" Collapse section "1.7. Configuring APIcast with OpenTracing" 1.7.1. Prerequisites 1.7.2. Procedure 1.7.3. Additional information 1.7.4. Installing Jaeger on your OpenShift instance 2. Operating Docker-containerized environments Expand section "2. Operating Docker-containerized environments" Collapse section "2. Operating Docker-containerized environments" 2.1. Troubleshooting APIcast on the Docker-containerized environment Expand section "2.1. Troubleshooting APIcast on the Docker-containerized environment" Collapse section "2.1. Troubleshooting APIcast on the Docker-containerized environment" 2.1.1. Cannot connect to the Docker daemon error 2.1.2. Basic Docker command-line interface commands 3. Advanced APIcast configuration Expand section "3. Advanced APIcast configuration" Collapse section "3. Advanced APIcast configuration" 3.1. Define a secret token 3.2. Credentials 3.3. Error messages 3.4. Configuration history 3.5. Debugging 3.6. Path routing 4. APIcast policies Expand section "4. APIcast policies" Collapse section "4. APIcast policies" 4.1. APIcast standard policies Expand section "4.1. APIcast standard policies" Collapse section "4.1. APIcast standard policies" 4.1.1. 3scale Auth Caching policy 4.1.2. 3scale Batcher policy 4.1.3. Anonymous Access policy 4.1.4. CORS Request Handling policy 4.1.5. Echo policy 4.1.6. Edge Limiting policy Expand section "4.1.6. Edge Limiting policy" Collapse section "4.1.6. Edge Limiting policy" 4.1.6.1. Types of limits 4.1.6.2. Limit definition 4.1.6.3. Liquid templating 4.1.6.4. Applying conditions 4.1.6.5. Configuring the store 4.1.6.6. Error handling 4.1.7. Header Modification policy 4.1.8. IP Check policy 4.1.9. Liquid Context Debug policy 4.1.10. Logging policy 4.1.11. OAuth 2.0 Token Introspection policy 4.1.12. Referrer policy 4.1.13. RH-SSO/Keycloak Role Check policy 4.1.14. Routing policy Expand section "4.1.14. Routing policy" Collapse section "4.1.14. Routing policy" 4.1.14.1. Routing rules 4.1.14.2. Request path rule 4.1.14.3. Header rule 4.1.14.4. Query argument rule 4.1.14.5. JWT claim rule 4.1.14.6. Multiple operations rule 4.1.14.7. Combining rules 4.1.14.8. Catch-all rules 4.1.14.9. Supported operations 4.1.14.10. Liquid templating 4.1.14.11. Set the host used in the Host header 4.1.15. Prometheus Metrics 4.1.16. SOAP policy 4.1.17. TLS Client Certificate Validation policy Expand section "4.1.17. TLS Client Certificate Validation policy" Collapse section "4.1.17. TLS Client Certificate Validation policy" 4.1.17.1. About TLS Client Certificate Validation policy 4.1.17.2. Setting up APIcast to work with TLS Client Certificate Validation Expand section "4.1.17.2. Setting up APIcast to work with TLS Client Certificate Validation" Collapse section "4.1.17.2. Setting up APIcast to work with TLS Client Certificate Validation" 4.1.17.2.1. Prerequisites: 4.1.17.2.2. Setting up APIcast to work with the policy 4.1.17.3. Configuring TLS Client Certificate Validation in your policy chain Expand section "4.1.17.3. Configuring TLS Client Certificate Validation in your policy chain" Collapse section "4.1.17.3. Configuring TLS Client Certificate Validation in your policy chain" 4.1.17.3.1. Prerequisites 4.1.17.3.2. Configuring the policy 4.1.17.4. Verifying functionality of the TLS Client Certificate Validation policy Expand section "4.1.17.4. Verifying functionality of the TLS Client Certificate Validation policy" Collapse section "4.1.17.4. Verifying functionality of the TLS Client Certificate Validation policy" 4.1.17.4.1. Prerequisites: 4.1.17.4.2. Verifying policy functionality 4.1.17.5. Removing a certificate from the whitelist Expand section "4.1.17.5. Removing a certificate from the whitelist" Collapse section "4.1.17.5. Removing a certificate from the whitelist" 4.1.17.5.1. Prerequisites 4.1.17.5.2. Removing a certificate 4.1.17.6. Reference material 4.1.18. Upstream policy 4.1.19. URL Rewriting policy Expand section "4.1.19. URL Rewriting policy" Collapse section "4.1.19. URL Rewriting policy" 4.1.19.1. Commands for rewriting the path 4.1.19.2. Commands for rewriting the query string 4.1.20. URL Rewriting with Captures policy 4.2. Enabling a standard policy 4.3. Creating custom APIcast policies 4.4. Adding custom policies to APIcast Expand section "4.4. Adding custom policies to APIcast" Collapse section "4.4. Adding custom policies to APIcast" 4.4.1. Adding custom policies to the built-in APIcast 4.4.2. Adding custom policies to APIcast on another OpenShift Container Platform 4.5. Creating a policy chain in 3scale 4.6. Creating a policy chain JSON configuration file 5. Integrating a policy chain with APIcast native deployments Expand section "5. Integrating a policy chain with APIcast native deployments" Collapse section "5. Integrating a policy chain with APIcast native deployments" 5.1. Using variables and filters in policies 6. APIcast environment variables Legal Notice Settings Close Language: 简体中文 日本語 English Language: 简体中文 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: 简体中文 日本語 English Language: 简体中文 日本語 English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Preface This guide will help you to apply intermediate to advanced configuration features to your 3scale installation. For basic details regarding installation, refer to Installing 3scale. Previous Next