Skip to main content

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 – América Latina
Français
Indonesia
Italiano
Português – Brasil
中文 – 简体
中文 – 繁體
日本語
한국어

Console

Sign in

Apigee

Overview Guides Reference Support Resources

Contact Us Start free

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
DEVELOP
Tutorial: Building your first API proxy
Tutorial: Creating an API proxy from an OpenAPI Specification
Building API proxies
- Understanding APIs and API proxies
- Programmable proxy basics
- Environments and organizations
- 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
Deploying API proxies
Deploying archives
Debugging programmable proxies
Performing health checks
DEVELOP (LOCAL)
Overview of local development with Apigee
Getting started
Developing using Apigee in Cloud Code
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
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
- Managing user account creation and sign-in experience
- Reference
  - Cookies
  - Markdown syntax
Building your portal using Drupal
- Introduction
- Drupal-based developer portal in Cloud Marketplace
- Choosing a hosting provider
- Support process for Apigee Drupal modules
MONETIZE
Overview of Apigee monetization
Steps to use Apigee monetization
Enabling Apigee monetization
Enforcing monetization limits in API proxies
Enforcing monetization quotas in API products
Managing prepaid account balances
Managing rate plans for API products
Integrating monetization in Drupal portal
Purchasing API product subscriptions using API
Debugging monetization using the Debug tool
Capturing monetization data
Generating monetization reports
ADMINISTER
Users, roles, and access
Network Configuration
Client IP resolution
Security administration
Managing data collectors
Backups
Switching between organizations
ANALYZE
Analytics overview
Using the analytics dashboards
API metrics
Developer analysis
- Developer engagement
- Traffic composition
End user analysis
- Devices
- Geomap
Custom reports
- Creating and managing custom reports
- Analytics metrics, dimensions, and filters reference
Operations Anomalies
Collecting custom data with the DataCapture policy
Exporting data from analytics
Obfuscate user data for analytics
Looker Studio Integration
Using the API
Troubleshooting
- Troubleshooting with analytics
- What does an analytics entity named 'not set' mean?
API MONITORING
API Monitoring overview
Compare API Monitoring with Apigee Analytics
Using the Timeline view
Using the Investigate view
Using the Recent view
Setting up alerts and notifications
Examples of alerts
Fault codes
ADVANCED API SECURITY
Overview of Advanced API Security
Getting started
Detection rules
Best practices
Security reports
- Security reports UI
- Security reports API
Risk assessment
- Risk assessment overview and UI
- Security scores and profiles API
Abuse detection
Security alerts
Security actions
- Security actions overview and UI
- Security actions API
API OBSERVATION
Overview of API Observation
Shadow APIs
ADVANCED API OPERATIONS
Advanced API Operations overview
Anomaly detection
Application Integration
Use Application Integration
Application Integration and Apigee proxy Integration target
Subscription entitlements
Application Integration policies
- IntegrationCallout policy
- SetIntegrationRequest policy
Connectors
Overview
Get started with connectors
Release notes
API HUB
What is Apigee API hub?
Provision API hub
Get started with API hub
Quickstarts
API resources
- Overview
- Manage API resources
Versions
- Overview
- Manage versions
Operations
- Overview
- Manage operations
Specifications
- Overview
- Manage specifications
Deployments
- Overview
- Manage deployments
API supply chain
API observations in API hub
Settings
Search and filter APIs
Audit logging for API hub
Access Control
API hub locations
Deprovision API hub
Tutorials
- Enrich API data with custom curation in API hub
Reference
- Limits
- REST Reference
  - v1
    Overview
    
    Resources
    REST Resources
    
    projects.locations
    Overview
    collectApiData
    get
    list
    lookupRuntimeProjectAttachment
    searchResources
    
    projects.locations.apiHubInstances
    Overview
    create
    delete
    get
    lookup
    
    projects.locations.apis
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.apis.versions
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.apis.versions.definitions
    Overview
    get
    
    projects.locations.apis.versions.operations
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.apis.versions.specs
    Overview
    create
    delete
    get
    getContents
    lint
    list
    patch
    
    projects.locations.attributes
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.curations
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.dependencies
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.deployments
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.externalApis
    Overview
    create
    delete
    get
    list
    patch
    
    projects.locations.hostProjectRegistrations
    Overview
    create
    get
    list
    
    projects.locations.operations
    Overview
    cancel
    delete
    get
    list
    
    projects.locations.plugins
    Overview
    create
    delete
    disable
    enable
    get
    getStyleGuide
    list
    updateStyleGuide
    
    projects.locations.plugins.instances
    Overview
    create
    delete
    disableAction
    enableAction
    executeAction
    get
    list
    patch
    
    projects.locations.plugins.styleGuide
    Overview
    getContents
    
    projects.locations.runtimeProjectAttachments
    Overview
    create
    delete
    get
    list
    Types
    AggregationFunction
    AllowedValue
    AttributeValues
    AuthType
    CollectApiDataResponse
    ConfigValueOption
    DisablePluginInstanceActionResponse
    Documentation
    EnablePluginInstanceActionResponse
    EnumerateExtendedApisRequest
    EnumerateExtendedApisResponse
    ExecutePluginInstanceActionResponse
    GoogleServiceAccountConfig
    InitializeSystemOwnedPluginRequest
    InitializeSystemOwnedPluginResponse
    InsightsMetric
    OperationMetadata
    Owner
    QueryApiMetricsRequest
    QueryApiMetricsResponse
    QueryDependencyMetricsRequest
    QueryDependencyMetricsResponse
    RemoveSystemOwnedPluginRequest
    RemoveSystemOwnedPluginResponse
    SourceMetadata
    StyleGuide
    StyleGuideContents
    WaitOperationRequest
- RPC Reference
- Client libraries
  - Overview
  - C#
  - Go
  - Java
  - Node.js
  - PHP
  - Python
Release notes
Envoy Adapter
v2.0.x
v1.4.x
v1.3.x
v1.2.x
v1.1.x
v1.0.x
Release notes
HYBRID RUNTIME
Supported platforms and versions
Kubernetes and custom resources used by Apigee
v1.15
v1.14
v1.13
Unsupported versions
Release notes
LOGGING
Audit logging
Audit logging for Apigee Connect
Logging Apigee access logs
TEST
Customer security testing requests
Performance testing
TROUBLESHOOT
Troubleshooting the Apigee installation
Logging Apigee access logs

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

Access and resources management
Costs and usage management
Google Cloud SDK, languages, frameworks, and tools
Infrastructure as code
Migration

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

Home
Apigee
Documentation
Guides

Data encryption

You are currently viewing version 1.1 of the Apigee hybrid documentation. This version is end of life. You should upgrade to a newer version. For more information, see Supported versions.

Supported versions: