Apigee technical feature overview

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

This topic summarizes the features in Apigee, and compares the features and functionality between Apigee and Apigee hybrid.

The following table lists the Apigee API management products that are compared in this topic:

Product Where hosted Managed by
Apigee Google Cloud Apigee
Apigee hybrid Both Google Cloud and the customer's private data center Apigee manages the management plane and the customer manages the runtime plane.

Summary of Apigee features

The following table provides a feature-level summary of Apigee (and hybrid).

Feature Support in Apigee and hybrid
API Proxy Revisions

Immutable when deployed

Apigee Adapter for Istio Deprecated: We recommend you use Apigee Adapter for Envoy instead.
  • Asynchronous deployments
  • Retrieving deployment status is based on the last time the runtime plane "checked-in" with the management plane
  • Support for environment groups
  • Self-service through the Apigee UI and APIs
  • Flexibility in serving topology
  • An MP pod can only serve one environment

For more information, see About environments and environment groups.

  • Northbound managed as Kubernetes secrets
  • You can create encrypted, environment-scoped KVMs in the Apigee UI. KVMs are always encrypted. You cannot add, update, or view KVM entries in the UI.
  • Use the private. attribute with all variables when accessing a KVM with the GET command to hide the KVM information in a debug (Trace) session. If the private. attribute is not used, the KVM is still encrypted; however, the KVM information will appear decrypted in the debug Trace) session and no exception will be thrown.
  • You can manage KVM entries using the keyvaluemaps.entries API or the KeyValueMapOperations policy.
  • You can use property sets for some of the same use cases as KVMs. See Using property sets.
  • The <MapName> element enables the KeyValueMapOperations policy to identify which KVM to use dynamically, at runtime.

For more information on creating KVMs in the UI, see Using key value maps. See also Accessing configuration data for information on how to choose the right data persistence mechanism.

Monetization See Monetization overview.
  • Node.js API proxies are not supported.
  • Apigee recommends that you host Node.js applications as separate containers in Kubernetes (same or different cluster)
OAuth New RevokeOAuthv2 policy revokes by end user ID, app ID, or both.
Policies See Policy overview.
Resources Cannot use organization-level resources
Roles and Permissions
  • Managed through Google Cloud console's IAM service
  • Some curated out-of-the-box roles are available
  • You can create custom roles which can include other Google Cloud permissions

For more information, see Users and roles.

SOAP services in the Build a proxy wizard Not supported. See wsdl2apigee, an open source project that provides SOAP utilities for use with Apigee.
Trace/Debug Sessions See Trace support.
Virtual Hosts

For hybrid:

  • The ingress is implemented through Anthos Service Mesh.
  • The keys and certs are deployed directly to Kubernetes.

For {product_name}}:

  • Each instance exposes an HTTPS endpoint via self-signed certificate. The CA for the certificate can be downloaded by querying the org.

Trace/Debug support

The following table shows the Apigee and hybrid Trace support:

Feature Apigee and hybrid support
Timeliness Slight delay; asynchronous
Session name/ID Doesn't accept session name from the user
Filters Support for complex filtering logic, including both AND and OR logical operations. Access to any flow variable mentioned in the flow variables reference. Syntax is the same as used with conditionals, as shown in the conditions reference.
Session timeout

Defines only the length of the debug session. The starting point is when the Message Processor receives the request to run in debug mode.

Default value is 5 minutes if the session was initiated with the API and 10 minutes if it was initiated in the UI.

Data is persisted for 24 hours before hybrid automatically deletes it.

Session validity Length of time in which the session creation request is valid. If the debug session does not start within this amount of time, the Synchronizers can disregard the session creation request. Be sure to keep your Synchronizers' clocks in synch, as described in Prerequisites.
Trace request count Default is 10 per Message Processor; maximum is 15.
APIs Apigee exposes the Debug Session API and Debug Session Data API

API overview

The following summarizes Apigee APIs and functionality.

Behavior Apigee APIs
Base domain apigee.googleapis.com
Media types application/json
Authentication OAuth2
Timestamps in keys String format
  "createdAt": "1234",
  "lastModifiedAt": "5678"
Structure of expand=false query parameter
  "proxies": [
      "name": "helloworld"
      "name": "weather"
Query parameters prefixed by underscore Not supported (optimal=true)
Properties in payloads:
  • created_by
  • modified_by
  • self
Not supported
Default values in payloads Not included
Error handling structure
  "error": {
    "code": 409,
    "message": "...",
    "status": "ABORTED",
    "details": [...]
Cache deletion response Returns: 204 No Content
Cache API operations List and delete only. Short-lived L1 cache is automatically created when you deploy an API proxy. For more information, see Cache internals.

Apigee metrics APIs

Summary of Apigee metric APIs:

Feature Apigee APIs
API endpoint apigee.googleapis.com
Daily analytics emails No APIs supported
Async Query List API The userId property is omitted from the response. See Method: organizations.environments.queries.list.
Custom report APIs The createdBy and lastModifiedBy properties have been removed from the response. See Reports API.

Apigee hybrid features

The following table summaizes hybrid features:

Service hybrid Area
Analytics A data collection pod in the runtime plane uses fluentd and UDCA (Universal Data Collection Agent) to gather analytics and feed the data to the UAP (Unified Analytics Platform) in the management plane.
API Proxy Gateway The Message Processor (MP) processes incoming requests. MPs are implemented as one or more containerized apps in the runtime plane.
Persistence Cassandra provides persistence for the KMS, KVM, quota, and cache features.
Deployment The Synchronizer ensures that API proxy configurations, environment information, and other data is kept up to date between the management plane and runtime plane.
Administrative User Interface The Apigee UI is a containerized app hosted on the management plane.
Load Balancing An Istio Ingress controller hands requests to the Router/Message Processor (RMP) containerized app in the runtime plane.
APIs Apigee APIs are accessed through the Management Server and MART. MART interacts with the local Cassandra datastore and serves as an API provider for the Apigee APIs to access and manage runtime data entities.
Metrics Managed by a single Prometheus server per cluster for all services.