Red Hat Customer Portal

Skip to main content

Main Navigation

  • Products & Services
    • Back
    • View All Products
    • Infrastructure and Management
      • Back
      • Red Hat Enterprise Linux
      • Red Hat Virtualization
      • Red Hat Identity Management
      • Red Hat Directory Server
      • Red Hat Certificate System
      • Red Hat Satellite
      • Red Hat Subscription Management
      • Red Hat Update Infrastructure
      • Red Hat Insights
      • Red Hat Ansible Automation Platform
    • Cloud Computing
      • Back
      • Red Hat CloudForms
      • Red Hat OpenStack Platform
      • Red Hat OpenShift Container Platform
      • Red Hat OpenShift Online
      • Red Hat OpenShift Dedicated
      • Red Hat Advanced Cluster Management for Kubernetes
      • Red Hat Quay
      • Red Hat CodeReady Workspaces
    • Storage
      • Back
      • Red Hat Gluster Storage
      • Red Hat Hyperconverged Infrastructure
      • Red Hat Ceph Storage
      • Red Hat Openshift Container Storage
    • Runtimes
      • Back
      • Red Hat Runtimes
      • Red Hat JBoss Enterprise Application Platform
      • Red Hat Data Grid
      • Red Hat JBoss Web Server
      • Red Hat Single Sign On
      • Red Hat support for Spring Boot
      • Red Hat build of Node.js
      • Red Hat build of Thorntail
      • Red Hat build of Eclipse Vert.x
      • Red Hat build of OpenJDK
      • Red Hat build of Quarkus
      • Red Hat CodeReady Studio
    • Integration and Automation
      • Back
      • Red Hat Integration
      • Red Hat Fuse
      • Red Hat AMQ
      • Red Hat 3scale API Management
      • Red Hat JBoss Data Virtualization
      • Red Hat Process Automation
      • Red Hat Process Automation Manager
      • Red Hat Decision Manager
    • Support
    • Production Support
    • Development Support
    • Product Life Cycles
    • Documentation
    • Red Hat Enterprise Linux
    • Red Hat JBoss Enterprise Application Platform
    • Red Hat OpenStack Platform
    • Red Hat OpenShift Container Platform
    • Services
    • Consulting
    • Technical Account Management
    • Training & Certifications
    • Ecosystem Catalog
    • Partner Resources
    • Red Hat in the Public Cloud
  • Tools
    • Back
    • Red Hat Insights
    • Tools
    • Solution Engine
    • Packages
    • Errata
    • Customer Portal Labs
    • Explore Labs
    • Configuration
    • Deployment
    • Security
    • Troubleshooting
  • Security
    • Back
    • Product Security Center
    • Security Updates
    • Security Advisories
    • Red Hat CVE Database
    • Security Labs
    • Resources
    • Overview
    • Security Blog
    • Security Measurement
    • Severity Ratings
    • Backporting Policies
    • Product Signing (GPG) Keys
  • Community
    • Back
    • Customer Portal Community
    • Discussions
    • Blogs
    • Private Groups
    • Community Activity
    • Customer Events
    • Red Hat Convergence
    • Red Hat Summit
    • Stories
    • Red Hat Subscription Value
    • You Asked. We Acted.
    • Open Source Communities
  • Subscriptions
  • Downloads
  • Containers
  • Support Cases
  • Account
    • Back
    • Log In
    • Register
    • Red Hat Account Number:
    • Account Details
    • User Management
    • Account Maintenance
    • My Profile
    • Notifications
    • Help
    • Log Out
  • Language
    • Back
    • English
    • 한국어
    • 日本語
    • 中文 (中国)
Red Hat Customer Portal
  • Products & Services
    • Back
    • View All Products
    • Infrastructure and Management
      • Back
      • Red Hat Enterprise Linux
      • Red Hat Virtualization
      • Red Hat Identity Management
      • Red Hat Directory Server
      • Red Hat Certificate System
      • Red Hat Satellite
      • Red Hat Subscription Management
      • Red Hat Update Infrastructure
      • Red Hat Insights
      • Red Hat Ansible Automation Platform
    • Cloud Computing
      • Back
      • Red Hat CloudForms
      • Red Hat OpenStack Platform
      • Red Hat OpenShift Container Platform
      • Red Hat OpenShift Online
      • Red Hat OpenShift Dedicated
      • Red Hat Advanced Cluster Management for Kubernetes
      • Red Hat Quay
      • Red Hat CodeReady Workspaces
    • Storage
      • Back
      • Red Hat Gluster Storage
      • Red Hat Hyperconverged Infrastructure
      • Red Hat Ceph Storage
      • Red Hat Openshift Container Storage
    • Runtimes
      • Back
      • Red Hat Runtimes
      • Red Hat JBoss Enterprise Application Platform
      • Red Hat Data Grid
      • Red Hat JBoss Web Server
      • Red Hat Single Sign On
      • Red Hat support for Spring Boot
      • Red Hat build of Node.js
      • Red Hat build of Thorntail
      • Red Hat build of Eclipse Vert.x
      • Red Hat build of OpenJDK
      • Red Hat build of Quarkus
      • Red Hat CodeReady Studio
    • Integration and Automation
      • Back
      • Red Hat Integration
      • Red Hat Fuse
      • Red Hat AMQ
      • Red Hat 3scale API Management
      • Red Hat JBoss Data Virtualization
      • Red Hat Process Automation
      • Red Hat Process Automation Manager
      • Red Hat Decision Manager
    • Support
    • Production Support
    • Development Support
    • Product Life Cycles
    • Documentation
    • Red Hat Enterprise Linux
    • Red Hat JBoss Enterprise Application Platform
    • Red Hat OpenStack Platform
    • Red Hat OpenShift Container Platform
    • Services
    • Consulting
    • Technical Account Management
    • Training & Certifications
    • Ecosystem Catalog
    • Partner Resources
    • Red Hat in the Public Cloud
  • Tools
    • Back
    • Red Hat Insights
    • Tools
    • Solution Engine
    • Packages
    • Errata
    • Customer Portal Labs
    • Explore Labs
    • Configuration
    • Deployment
    • Security
    • Troubleshooting
  • Security
    • Back
    • Product Security Center
    • Security Updates
    • Security Advisories
    • Red Hat CVE Database
    • Security Labs
    • Resources
    • Overview
    • Security Blog
    • Security Measurement
    • Severity Ratings
    • Backporting Policies
    • Product Signing (GPG) Keys
  • Community
    • Back
    • Customer Portal Community
    • Discussions
    • Blogs
    • Private Groups
    • Community Activity
    • Customer Events
    • Red Hat Convergence
    • Red Hat Summit
    • Stories
    • Red Hat Subscription Value
    • You Asked. We Acted.
    • Open Source Communities
  • Subscriptions
  • Downloads
  • Containers
  • Support Cases
  • Account
    • Back
    • Log In
    • Register
    • Red Hat Account Number:
    • Account Details
    • User Management
    • Account Maintenance
    • My Profile
    • Notifications
    • Help
    • Log Out
  • Language
    • Back
    • English
    • 한국어
    • 日本語
    • 中文 (中国)
  • Subscriptions
  • Downloads
  • Containers
  • Support Cases
  • Search
  • Log In
  • Language
Or troubleshoot an issue.

Log in to Your Red Hat Account

Log In

Your Red Hat account gives you access to your profile, preferences, and services, depending on your status.

Register

If you are a new customer, register now for access to product evaluations and purchasing capabilities.

Need access to an account?

If your company has an existing Red Hat account, your organization administrator can grant you access.

If you have any questions, please contact customer service.

Red Hat Account Number:

Red Hat Account

  • Account Details
  • User Management
  • Account Maintenance
  • Account Team

Customer Portal

  • My Profile
  • Notifications
  • Help

For your security, if you’re on a public computer and have finished using your Red Hat services, please be sure to log out.

Log Out

Select Your Language

  • English
  • 한국어
  • 日本語
  • 中文 (中国)
Red Hat Customer Portal Red Hat Customer Portal
  • Products & Services
  • Tools
  • Security
  • Community
  • Infrastructure and Management

  • Cloud Computing

  • Storage

  • Runtimes

  • Integration and Automation

  • Red Hat Enterprise Linux
  • Red Hat Virtualization
  • Red Hat Identity Management
  • Red Hat Directory Server
  • Red Hat Certificate System
  • Red Hat Satellite
  • Red Hat Subscription Management
  • Red Hat Update Infrastructure
  • Red Hat Insights
  • Red Hat Ansible Automation Platform
  • Red Hat CloudForms
  • Red Hat OpenStack Platform
  • Red Hat OpenShift Container Platform
  • Red Hat OpenShift Online
  • Red Hat OpenShift Dedicated
  • Red Hat Advanced Cluster Management for Kubernetes
  • Red Hat Quay
  • Red Hat CodeReady Workspaces
  • Red Hat OpenShift Service on AWS
  • Red Hat Gluster Storage
  • Red Hat Hyperconverged Infrastructure
  • Red Hat Ceph Storage
  • Red Hat Openshift Container Storage
  • Red Hat Runtimes
  • Red Hat JBoss Enterprise Application Platform
  • Red Hat Data Grid
  • Red Hat JBoss Web Server
  • Red Hat Single Sign On
  • Red Hat support for Spring Boot
  • Red Hat build of Node.js
  • Red Hat build of Thorntail
  • Red Hat build of Eclipse Vert.x
  • Red Hat build of OpenJDK
  • Red Hat build of Quarkus
  • Red Hat CodeReady Studio
  • Red Hat Integration
  • Red Hat Fuse
  • Red Hat AMQ
  • Red Hat 3scale API Management
  • Red Hat JBoss Data Virtualization
  • Red Hat Process Automation
  • Red Hat Process Automation Manager
  • Red Hat Decision Manager
View All Products
  • Support
  • Production Support
  • Development Support
  • Product Life Cycles

Services

  • Consulting
  • Technical Account Management
  • Training & Certifications
  • Documentation
  • Red Hat Enterprise Linux
  • Red Hat JBoss Enterprise Application Platform
  • Red Hat OpenStack Platform
  • Red Hat OpenShift Container Platform
  • Ecosystem Catalog
  • Red Hat in the Public Cloud
  • Partner Resources

Tools

  • Solution Engine
  • Packages
  • Errata
  • Customer Portal Labs
  • Configuration
  • Deployment
  • Security
  • Troubleshooting

Red Hat Insights

Increase visibility into IT operations to detect and resolve technical issues before they impact your business.

  • Learn more
  • Go to Insights

Red Hat Product Security Center

Engage with our Red Hat Product Security team, access security updates, and ensure your environments are not exposed to any known security vulnerabilities.

Product Security Center

Security Updates

  • Security Advisories
  • Red Hat CVE Database
  • Security Labs

Keep your systems secure with Red Hat's specialized responses to security vulnerabilities.

  • View Responses

Resources

  • Overview
  • Security Blog
  • Security Measurement
  • Severity Ratings
  • Backporting Policies
  • Product Signing (GPG) Keys

Customer Portal Community

  • Discussions
  • Blogs
  • Private Groups
  • Community Activity

Customer Events

  • Red Hat Convergence
  • Red Hat Summit

Stories

  • Red Hat Subscription Value
  • You Asked. We Acted.
  • Open Source Communities
Show Table of Contents
Hide Table of Contents
  • English
  • 日本語
  • Single-page HTML
  • PDF
  • ePub
  1. Administering the API Gateway
  2. Preface
  3. I. The API gateway
    1. 1. Operating APIcast
      1. 1.1. Public Base URL
      2. 1.2. Mapping rules
        1. 1.2.1. Mapping rules in products and backends
        2. 1.2.2. Matching of mapping rules
        3. 1.2.3. Mapping rules workflow
      3. 1.3. Host header
      4. 1.4. Protecting your API backend
      5. 1.5. Using APIcast with private APIs
      6. 1.6. Configuring APIcast with OpenTracing
        1. 1.6.1. Prerequisites
        2. 1.6.2. Procedure
        3. 1.6.3. Additional information
        4. 1.6.4. Installing Jaeger on your OpenShift instance
    2. 2. Operating Docker-containerized environments
      1. 2.1. Troubleshooting APIcast on the Docker-containerized environment
        1. 2.1.1. Cannot connect to the Docker daemon error
        2. 2.1.2. Basic Docker command-line interface commands
    3. 3. Advanced APIcast configuration
      1. 3.1. Define a secret token
      2. 3.2. Credentials
      3. 3.3. Configuring error messages
      4. 3.4. Configuration history
      5. 3.5. Debugging
      6. 3.6. Path routing
    4. 4. APIcast policies
      1. 4.1. APIcast standard policies
        1. 4.1.1. 3scale Auth Caching
        2. 4.1.2. 3scale Batcher
        3. 4.1.3. 3scale Referrer
        4. 4.1.4. Anonymous Access
        5. 4.1.5. Conditional Policy
        6. 4.1.6. CORS Request Handling
        7. 4.1.7. Echo
        8. 4.1.8. Edge Limiting
        9. 4.1.9. Header Modification
        10. 4.1.10. IP Check
        11. 4.1.11. JWT Claim Check
        12. 4.1.12. Liquid Context Debug
        13. 4.1.13. Logging
        14. 4.1.14. Maintenance Mode
        15. 4.1.15. OAuth 2.0 Mutual TLS Client Authentication
        16. 4.1.16. OAuth 2.0 Token Introspection
        17. 4.1.17. Proxy Service
        18. 4.1.18. Retry
        19. 4.1.19. RH-SSO/Keycloak Role Check
        20. 4.1.20. Routing
        21. 4.1.21. SOAP
        22. 4.1.22. TLS Client Certificate Validation
        23. 4.1.23. TLS Termination
        24. 4.1.24. Upstream
        25. 4.1.25. Upstream Connection
        26. 4.1.26. Upstream Mutual TLS
        27. 4.1.27. URL Rewriting
        28. 4.1.28. URL Rewriting with Captures
      2. 4.2. Enabling a policy in the Admin Portal
      3. 4.3. Creating custom APIcast policies
      4. 4.4. Adding custom policies to APIcast
        1. 4.4.1. Adding custom policies to the APIcast deployments
        2. 4.4.2. Adding custom policies to the embedded APIcast
        3. 4.4.3. Adding custom policies to APIcast on another OpenShift Container Platform
      5. 4.5. Creating a policy chain in 3scale
      6. 4.6. Creating a policy chain JSON configuration file
    5. 5. Integrating a policy chain with APIcast native deployments
      1. 5.1. Using variables and filters in policies
    6. 6. Transforming 3scale message content using policy extensions in Fuse
      1. 6.1. Integrating APIcast with Apache Camel transformations in Fuse
      2. 6.2. Configuring an APIcast policy extension created using Apache Camel in Fuse on OpenShift
    7. 7. APIcast environment variables
    8. 8. Configuring APIcast for better performance
      1. 8.1. General guidelines
      2. 8.2. Default caching
      3. 8.3. Asynchronous reporting threads
      4. 8.4. 3scale Batcher policy
    9. 9. Exposing 3scale APIcast Metrics to Prometheus
      1. 9.1. About Prometheus
        1. 9.1.1. Prometheus queries
      2. 9.2. APIcast integration with Prometheus
        1. 9.2.1. Additional options
      3. 9.3. OpenShift environment variables for 3scale APIcast
      4. 9.4. 3scale APIcast metrics exposed to Prometheus
  4. II. API versioning
    1. 10. API Versioning
      1. 10.1. Goal
      2. 10.2. Prerequisites
      3. 10.3. URL versioning
      4. 10.4. Endpoint versioning
      5. 10.5. Custom header versioning
  5. III. API authentication
    1. 11. Authentication patterns
      1. 11.1. Supported authentication patterns
      2. 11.2. Setting up authentication patterns
        1. 11.2.1. Select the authentication mode for your service
        2. 11.2.2. Select the Authentication mode you want to use
        3. 11.2.3. Ensure your API accepts the correct types of credentials
        4. 11.2.4. Create an application to test credentials
      3. 11.3. Standard authentication patterns
        1. 11.3.1. API key
        2. 11.3.2. App_ID and App_Key pair
        3. 11.3.3. OpenID Connect
      4. 11.4. Referrer filtering
    2. 12. OpenID Connect integration
      1. 12.1. JWT verification and parsing by APIcast
      2. 12.2. Client credentials synchronization by Zync
      3. 12.3. Configure Red Hat Single Sign-On integration
        1. 12.3.1. Configure Zync to use custom CA certificates
        2. 12.3.2. Configure Red Hat Single Sign-On
        3. 12.3.3. Configure 3scale
      4. 12.4. Configure HTTP integration with third-party Identity Providers
        1. 12.4.1. Pre-requisites
        2. 12.4.2. Procedure
        3. 12.4.3. Zync REST API example
      5. 12.5. OAuth 2.0 supported flows
        1. 12.5.1. How OAuth 2.0 supported flows work
        2. 12.5.2. Configuring OAuth 2.0 supported flows
      6. 12.6. Test the integration
        1. 12.6.1. Test the client synchronization
        2. 12.6.2. Test the API authorization flow
      7. 12.7. Example of the integration
  6. Legal Notice

Part II. API versioning

  • 9.4. 3scale APIcast metrics exposed to Prometheus
  • 10. API Versioning
Red Hat

Quick Links

  • Downloads
  • Subscriptions
  • Support Cases
  • Customer Service
  • Product Documentation

Help

  • Contact Us
  • Customer Portal FAQ
  • Log-in Assistance

Site Info

  • Trust Red Hat
  • Browser Support Policy
  • Accessibility
  • Awards and Recognition
  • Colophon

Related Sites

  • redhat.com
  • openshift.com
  • developers.redhat.com
  • connect.redhat.com

About

  • Red Hat Subscription Value
  • About Red Hat
  • Red Hat Jobs
Copyright © 2021 Red Hat, Inc.
  • Privacy Statement
  • Customer Portal Terms of Use
  • All Policies and Guidelines
Red Hat Summit
Twitter Facebook

Formatting Tips

Here are the common uses of Markdown.

Code blocks
~~~
Code surrounded in tildes is easier to read
~~~
Links/URLs
[Red Hat Customer Portal](https://access.redhat.com)
Learn more