Skip to main content
Google Cloud
Documentation Technology areas
  • AI and ML
  • Application development
  • Application hosting
  • Compute
  • Data analytics and pipelines
  • Databases
  • Distributed, hybrid, and multicloud
  • Generative AI
  • Industry solutions
  • Networking
  • Observability and monitoring
  • Security
  • Storage
Cross-product tools
  • Access and resources management
  • Costs and usage management
  • Google Cloud SDK, languages, frameworks, and tools
  • Infrastructure as code
  • Migration
Related sites
  • Google Cloud Home
  • Free Trial and Free Tier
  • Architecture Center
  • Blog
  • Contact Sales
  • Google Cloud Developer Center
  • Google Developer Center
  • Google Cloud Marketplace
  • Google Cloud Marketplace Documentation
  • Google Cloud Skills Boost
  • Google Cloud Solution Center
  • Google Cloud Support
  • Google Cloud Tech Youtube Channel
/
  • English
  • Deutsch
  • Español
  • Español – América Latina
  • Français
  • Indonesia
  • Italiano
  • Português
  • Português – Brasil
  • 中文 – 简体
  • 中文 – 繁體
  • 日本語
  • 한국어
Console Sign in
  • Apigee
Overview Guides Reference Support Resources
Contact Us Start free
Google Cloud
  • Documentation
    • Overview
    • Guides
    • Reference
    • Support
    • Resources
  • Technology areas
    • More
  • Cross-product tools
    • More
  • Related sites
    • More
  • Console
  • Contact Us
  • Start free
  • DISCOVER
  • What is Apigee?
  • Apigee technical feature overview
  • Apigee terminology
  • API development lifecycle
  • Key points of API proxy development
  • Apigee architecture overview
  • Apigee locations
  • Gemini Code Assist
  • GET STARTED
  • Introduction to provisioning
  • Compare eval and paid organizations
  • Provisioning options
  • Prerequisites
  • About Apigee provisioning permissions
  • Networking options
  • Introduction to data residency
  • Introduction to CMEK
  • Best practices for Apigee CMEK
  • Using organization policy constraints
  • Understand Apigee observability
  • Paid orgs
    • Before you begin
    • Subscription
      • Cloud console
        • Select your project
        • Provision Apigee with one click
        • Configure and customize
          • Step 1: Enable required APIs
          • Step 2: Set up networking
          • Step 3: Configure hosting and encryption
          • Step 4: Customize access routing
        • Recommended next steps
      • Command line
        • With VPC peering
        • Without VPC peering
    • Pay-as-you-go
      • Cloud console
        • Select your project
        • Provision Apigee with one click
        • Configure and customize
          • Step 1: Enable required APIs
          • Step 2: Set up networking
          • Step 3: Configure hosting and encryption
          • Step 4: Customize access routing
        • Recommended next steps
      • Command line
        • With VPC peering
        • Without VPC peering
  • Eval orgs
    • Before you begin
    • Wizard
    • Command line
      • With VPC peering
      • Without VPC peering
  • Next steps
    • Calling a proxy with internal-only access
    • Accessing Apigee
    • Using the UI
    • Using the API
    • Get information about calls to your APIs
    • Using gcloud
    • Troubleshooting
  • DEVELOP
  • Tutorial: Building your first API proxy
    • Overview
    • Step 1: Create an API proxy
    • Step 2: Deploy an API proxy
    • Step 3: Call an API proxy
    • Step 4: Change the target endpoint
    • Step 5: Add a policy
    • Next steps: Go deeper
  • Tutorial: Creating an API proxy from an OpenAPI Specification
  • Building API proxies
    • Understanding APIs and API proxies
    • Programmable proxy basics
      • Introduction to API proxy building
      • Creating an API proxy
      • Editing an API proxy (create a revision)
      • Downloading and uploading an API proxy configuration bundle
      • Deleting an API proxy
    • Environments and organizations
      • Understanding organizations
      • Overview of environments and environment groups
      • Working with environments
      • Working with environment groups
    • Best practices
    • Routes and flows
      • Understanding routes
      • Controlling API proxies with flows
      • Conditional flows
      • Flow variables
        • Flow variable overview
        • Request and response flow variables
        • Message flow variable
        • Conditions with flow variables
      • Shared flows and flow hooks
        • Creating reusable shared flows
        • Attaching a shared flow using flow hooks
      • Chaining API proxies together
    • Handling faults
  • Adding features to a programmable API proxy
    • Using policies
      • Tutorial: Adding the SpikeArrest policy
      • What's a policy?
      • Attaching and configuring policies in the UI
      • Attaching and configuring policies in XML files
      • Attaching a policy to a ProxyEndpoint or TargetEndpoint flow
      • Managing resources
      • About policy errors
    • Securing an API proxy
      • Security overview
      • IAM
        • IAM-based API authentication
      • OAuth2
        • Tutorial: Securing an API proxy with OAuth
        • Getting started with OAuth2
        • Introduction to OAuth 2.0
        • Videos
        • Client credentials grant type
        • Auth code grant type
        • Password grant type
        • Using JWT access tokens
        • Configuring a new API proxy
        • Registering client apps
        • Obtaining client credentials
        • Understanding OAuth endpoints
        • Requesting tokens and codes
        • Customizing tokens and codes
        • Revoking and approving tokens
        • Revoking tokens by end user ID and app ID
        • Revoking and approving consumer keys
        • Sending an access token
        • Verifying access token
        • Working with OAuth2 scopes
        • Using third-party OAuth tokens
        • Hashing tokens for extra security
        • Advanced OAuth2 topics
      • API keys
        • Tutorial: Securing an API proxy with API keys
        • API keys
        • Setting up API key validation
      • Using Google authentication
      • Using SAML policies in an API proxy
      • Content-based security
      • Masking and hiding data
      • Last-mile security
    • Using AI policies
      • Get started with Model Armor
      • Get started with semantic caching
    • Limit request traffic
      • Rate-limiting
      • Comparing rate-limiting policies
    • Caching and persistence
      • Overview
      • General purpose caching
      • Response caching
      • Using key value maps
      • Using property sets
      • Support for HTTP response headers
      • Cache internals
      • Videos
    • Shaping, accessing, and converting messages
    • Accessing configuration data
    • Incorporating procedural code
    • Adding CORS support
    • Enabling distributed tracing
    • Using GraphQL
    • Streaming requests and responses
    • Streaming server-sent events
    • Using WebSockets
    • Creating Java callouts
      • How to create Java Callout
      • How to handle JavaCallout policy errors
      • How to use properties in the JavaCallout
      • Adding a custom Java callout security policy
    • Integrating with Contact Center AI
  • Deploying API proxies
    • Deployment overview
    • Deploying an API proxy
    • Undeploying an API proxy
    • Load balancing across backend servers
  • Deploying archives
  • Debugging programmable proxies
    • Tutorial: View message data with the Debug view
    • Debug overview
    • Using Debug
    • Using Offline Debug
    • Using performance metrics
  • Performing health checks
  • DEVELOP (LOCAL)
  • Overview of local development with Apigee
  • Getting started
    • Setting up Apigee in Cloud Code
    • Using Apigee in Cloud Code
    • Tutorial: Using Gemini Code Assist for API lifecycle management
    • Tutorial: Building and deploying your first API proxy
      • Overview
      • Step 1: Create an Apigee workspace
      • Step 2: Create an API proxy
      • Step 3: Configure and deploy an environment
      • Step 4: Test your API
      • Step 5: Change your target endpoint
      • Step 6: Attach a policy
      • Step 7: Deploy to an Apigee environment
      • Step 8: Promote an archive to production
  • Developing using Apigee in Cloud Code
    • Managing the Apigee workspace
    • Designing and editing APIs
    • Developing API proxies
    • Developing shared flows
    • Adding features using policies
    • Managing resources
    • Building and exporting test resources
    • Configuring and deploying environments
    • Testing APIs
    • Deploying an archive to an Apigee environment
    • Managing the Apigee Emulator
    • Apigee Command Palette Reference
  • DEVELOP (Kubernetes)
  • Apigee APIM Operator for Kubernetes Overview
  • Before you begin
  • Install the Apigee APIM Operator
  • Use APIM policies with the Apigee APIM Operator
  • Add policies to the GKE gateway
  • Update Apigee policies with the Apigee APIM Operator
  • Uninstall the Apigee APIM Operator
  • Troubleshoot the Apigee APIM Operator
  • Apigee APIM Operator resource reference
  • Licenses in Apigee APIM Operator
  • DEVELOP (Service Extensions)
  • Apigee Extension Processor overview
  • Get started with the Apigee Extension Processor
  • PUBLISH
  • Publishing overview
  • Managing API products
    • What is an API product?
    • Managing API products
  • Managing client applications
    • Organizing client app ownership
    • Controlling developer access to your apps
      • App access overview
      • Registering app developers
      • Importing existing consumer keys and secrets
  • Developer portal solutions
  • API design overview
  • Building your integrated portal
    • Introduction
    • How portal users interact with your portal
    • Getting started
      • Tutorial: Building your first portal
        • Overview
        • Step 1: Create a portal
        • Step 2: Customize the color palette
        • Step 3: Customize the logo
        • Step 4: Edit page content
        • Step 5: Set up navigation
        • Step 6: Publish an API
      • Quick tips for customizing the sample portal
      • Best practices for building your portal
    • Building and publishing your portal
      • Steps to build your portal
      • Managing your portals
      • Managing the pages in your portal
      • Developing portal content
      • Customizing your theme
      • Setting up navigation
      • Publishing your APIs
      • Managing access to your APIs using API keys
      • Managing the default visibility
      • Managing your assets
      • Customizing your domain
      • Configuring email
      • Configure a content security policy
      • Configuring analytics tracking
      • Adding custom scripts
      • Publishing your portal content
      • Viewing your live portal
      • Creating a custom search page
    • Managing user account creation and sign-in experience
      • Configuring the user account creation and sign-in experience
      • Configuring identity providers
      • Managing user accounts
      • Managing developer teams
      • Managing audiences
    • Reference
      • Cookies
      • Markdown syntax
  • Building your portal using Drupal
    • Introduction
    • Drupal-based developer portal in Cloud Marketplace