Jump To Close Expand all Collapse all Table of contents Administering the API Gateway Making open source more inclusive I. The API gateway Expand section "I. The API gateway" Collapse section "I. The API gateway" 1. Introduction to advanced operation of 3scale APIcast API gateway Expand section "1. Introduction to advanced operation of 3scale APIcast API gateway" Collapse section "1. Introduction to advanced operation of 3scale APIcast API gateway" 1.1. Public base URL for calls to 3scale APIs 1.2. How APIcast applies mapping rules for capturing usage of 3scale APIs 1.3. How APIcast handles APIs that have custom requirements 1.4. Configuring APIcast to use OpenTracing 1.5. 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. Configuring 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. Standard policies to change default 3scale APIcast behavior Expand section "4.1. Standard policies to change default 3scale APIcast behavior" Collapse section "4.1. Standard policies to change default 3scale APIcast behavior" 4.1.1. Enabling policies in the 3scale Admin Portal 4.1.2. 3scale Auth Caching 4.1.3. 3scale Batcher 4.1.4. 3scale Referrer 4.1.5. Anonymous Access 4.1.6. Camel Service 4.1.7. Conditional Policy 4.1.8. Content Caching 4.1.9. CORS Request Handling 4.1.10. Custom Metrics 4.1.11. Echo 4.1.12. Edge Limiting 4.1.13. Header Modification 4.1.14. HTTP Status Code Overwrite 4.1.15. HTTP2 Endpoint 4.1.16. IP Check 4.1.17. JWT Claim Check 4.1.18. Liquid Context Debug 4.1.19. Logging Expand section "4.1.19. Logging" Collapse section "4.1.19. Logging" 4.1.19.1. Configuring the logging policy for all APIs Expand section "4.1.19.1. Configuring the logging policy for all APIs" Collapse section "4.1.19.1. Configuring the logging policy for all APIs" 4.1.19.1.1. Configuring the logging policy for all APIs by mounting the file on the container via ConfigMap and VolumeMount 4.1.19.1.2. Configuring the logging policy for all APIs using a secret referenced in the APIManager custom resource (CR) 4.1.19.1.3. Configuring the logging policy for all APIs for APIcast self-managed deployed on Docker 4.1.19.2. Examples of the logging policy 4.1.19.3. Additional information about custom logging 4.1.20. Maintenance Mode 4.1.21. NGINX Filter 4.1.22. OAuth 2.0 Mutual TLS Client Authentication 4.1.23. OAuth 2.0 Token Introspection 4.1.24. On Fail 4.1.25. Proxy Service 4.1.26. Rate Limit Headers 4.1.27. Response/Request Content Limits 4.1.28. Retry 4.1.29. RH-SSO/Keycloak Role Check 4.1.30. Routing 4.1.31. SOAP 4.1.32. TLS Client Certificate Validation 4.1.33. TLS Termination 4.1.34. Upstream 4.1.35. Upstream Connection 4.1.36. Upstream Mutual TLS 4.1.37. URL Rewriting 4.1.38. URL Rewriting with Captures 4.1.39. Websocket 4.2. Policy chains from 3scale standard policies Expand section "4.2. Policy chains from 3scale standard policies" Collapse section "4.2. Policy chains from 3scale standard policies" 4.2.1. How APIcast NGINX phases process 3scale policies 4.2.2. Modifying policy chains in the 3scale Admin Portal 4.2.3. Creating 3scale policy chains in JSON configuration files 4.2.4. NGINX phases that run 3scale standard policy functions 4.2.5. 3scale standard policies and the NGINX phases that process them 4.3. Custom 3scale APIcast policies Expand section "4.3. Custom 3scale APIcast policies" Collapse section "4.3. Custom 3scale APIcast policies" 4.3.1. About custom policies for 3scale APIcast deployments 4.3.2. Adding custom policies to 3scale embedded APIcast 4.3.3. Adding custom policies to 3scale in another OpenShift Container Platform 4.3.4. Including external Lua dependencies in 3scale custom policies 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. Transforming 3scale message content using policy extensions in Fuse Expand section "6. Transforming 3scale message content using policy extensions in Fuse" Collapse section "6. Transforming 3scale message content using policy extensions in Fuse" 6.1. Integrating APIcast with Apache Camel transformations in Fuse 6.2. Configuring an APIcast policy extension created using Apache Camel in Fuse on OpenShift 7. APIcast environment variables 8. Configuring APIcast for better performance Expand section "8. Configuring APIcast for better performance" Collapse section "8. Configuring APIcast for better performance" 8.1. General guidelines 8.2. Default caching 8.3. Asynchronous reporting threads 8.4. 3scale Batcher policy 9. Exposing 3scale APIcast Metrics to Prometheus Expand section "9. Exposing 3scale APIcast Metrics to Prometheus" Collapse section "9. Exposing 3scale APIcast Metrics to Prometheus" 9.1. About Prometheus Expand section "9.1. About Prometheus" Collapse section "9.1. About Prometheus" 9.1.1. Prometheus queries 9.2. APIcast integration with Prometheus Expand section "9.2. APIcast integration with Prometheus" Collapse section "9.2. APIcast integration with Prometheus" 9.2.1. Additional options 9.3. OpenShift environment variables for 3scale APIcast 9.4. 3scale APIcast metrics exposed to Prometheus II. API versioning Expand section "II. API versioning" Collapse section "II. API versioning" 10. API Versioning Expand section "10. API Versioning" Collapse section "10. API Versioning" 10.1. Goal 10.2. Prerequisites 10.3. URL versioning 10.4. Endpoint versioning 10.5. Custom header versioning III. API authentication Expand section "III. API authentication" Collapse section "III. API authentication" 11. Authentication patterns Expand section "11. Authentication patterns" Collapse section "11. Authentication patterns" 11.1. Supported authentication patterns 11.2. Setting up authentication patterns Expand section "11.2. Setting up authentication patterns" Collapse section "11.2. Setting up authentication patterns" 11.2.1. Select the authentication mode for your service 11.2.2. Select the Authentication mode you want to use 11.2.3. Ensure your API accepts the correct types of credentials 11.2.4. Create an application to test credentials 11.3. Standard authentication patterns Expand section "11.3. Standard authentication patterns" Collapse section "11.3. Standard authentication patterns" 11.3.1. API key 11.3.2. App_ID and App_Key pair 11.3.3. OpenID Connect 11.4. Referrer filtering 12. Integrating 3scale with an OpenID Connect identity provider Expand section "12. Integrating 3scale with an OpenID Connect identity provider" Collapse section "12. Integrating 3scale with an OpenID Connect identity provider" 12.1. Overview of integrating 3scale and an OpenID Connect identity provider 12.2. How APIcast processes JSON Web Tokens 12.3. How 3scale Zync synchronizes application details with OpenID Connect identity providers 12.4. Integrating 3scale with Red Hat Single Sign-On as the OpenID Connect identity provider Expand section "12.4. Integrating 3scale with Red Hat Single Sign-On as the OpenID Connect identity provider" Collapse section "12.4. Integrating 3scale with Red Hat Single Sign-On as the OpenID Connect identity provider" 12.4.1. Configuring 3scale Zync to use custom Certificate Authority certificates 12.4.2. Configuring RH-SSO to have a 3scale client 12.4.3. Configuring 3scale to work with RH-SSO 12.5. Integrating 3scale with third-party OpenID Connect identity providers 12.6. Testing 3scale integrations with OpenID Connect identity providers 12.7. Example of a 3scale integration with an OpenID Connect identity provider 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 Part I. The API gateway Previous Next