You're viewing Apigee Edge documentation.
Go to the
Apigee X documentation. info
This page describes notable changes we made in the Apigee documentation over the past (and prior) periods.
In addition to this page, keep an eye on the Apigee Release Notes for documentation updates that correspond to specific Apigee releases.
May 3, 2020
Apigee Edge for Public Cloud
Version 20.04.06 API Runtime (Message Processor)
For details, see the Release notes.
Apigee Edge for Private Cloud
Version 4.19.06.06, 4.19.01.06, 4.18.05.06 (5/1/20)
Security patch and bug fix release. For details, see:
Version 4.19.06.05, 4.19.01.05 (4/22/20)
mTLS update and security patch release. For details, see:
Retirement: Pivotal Cloud Foundry Integration
Apigee service broker for Pivotal Cloud Foundry (PCF) reached its end of life on 4/30/20. Documention topics for PCF Integration have been removed from the Apigee doc site. See also Retirements.
April 13, 2020
Apigee Edge for Public Cloud
Version 20.04.06 API Management and Monetization Management release
For details, see the Release notes.
Version 20.04.20 Apigee Edge integrated portal release
For details, see the Release notes.
Apigee hybrid
Version 20.04.21 Apigee hybrid UI release
For details, see the Release notes.
Apigee Edge Microgateway
Version 3.1.4 release
Includes an important bug fix. See the Release notes.
Version 3.1.3 release
Includes bug fixes and feature updates. For details, see the Release notes.
Apigee Edge for Private Cloud
4.19.06.05 - Edge for Private Cloud release
See the Release notes.
April 3, 2020
Apigee hybrid
Apigee hybrid 1.2.0 released
Includes WebSocket support, virtual host configuration, Kubernetes Secret access, new ways to access service accounts and certificates, data obfuscation, and more.
For more information, see Apigee hybrid release notes.
20.04.03 - Apigee hybrid UI release released
Includes UI support for OASValidation policy (in beta).
For more information, see Apigee hybrid UI release notes.
New Apigee hybrid metrics documentation
A new doc topic was added that describes how to access and use hybrid metrics data on StackDriver.
For more information, see View metrics.
New OASValidation (OpenAPI Specification Validation) policy (Beta)
The OASValidation policy (Beta) enables you to validate an incoming request or response message against an OpenAPI 3.0 Specification (JSON or YAML).
For more information, see OASValidation policy (Beta).
March 19, 2020
Apigee hybrid
General Availability (GA) release of Apigee hybrid components
The GA release of Apigee hybrid components is now available.
For more information, see General Availability (GA) release of Apigee hybrid components.
March, 3, 2020
Integrated portals
Enhancements to audience visibility management in integrated portals
Enhancements to audience visibility management have been implemented in this release.
For more information, see Manage the visibility of an API in your portal (Beta) and Manage the visibility of a page in your portal (Beta)
February 28, 2020
Private Cloud
Apigee mTLS for Private Cloud
Apigee released Apigee mTLS for Apigee Edge for Private Cloud. Apigee mTLS provides secure, mutually authenticated TLS connections between components. Apigee mTLS supports Private Cloud versions 4.19.01 and 4.19.06.
For more information, see Introduction to Apigee mTLS.
February 23, 2020
Apigee hybrid
New hybrid metrics
Apigee added support for viewing hybrid metrics in Stackdriver.
For more information, see View metrics.
February 14, 2020
Apigee Edge
Manage machine users for SAML identity zones
A machine user can obtain OAuth 2.0 tokens without having to specify a passcode enabling you to automate the token generation process when SAML is enabled. You can now manage machine users for SAML identity zones using a command-line tool provided by Apigee.
For more information, see Manage machine users for SAML identity zones.
December 8, 2019
Private Cloud
Japanese translation
Apigee added the Japanese translation for Apigee Edge for Private Cloud.
November 20, 2019
Apigee hybrid
Apigee hybrid GA released
Apigee released hybrid, which lets you manage APIs on-premises, on Google Cloud Platform (GCP), or a mix of both.
For more information, see What is Apigee hybrid?
November 10, 2019
Cloud
Advanced API Ops (Beta)
Apigee added an advanced set of operations and security features called Advanced API Ops. Advanced API Ops includes advanced security reporting, anomaly detection, and advanced alerts.
For more information, see Introduction to Advanced API Ops.
September 30, 2019
Following are notable doc updates between the previous period and the date above.
Cloud
- We added Shared flows permissions to the Permissions reference
Private Cloud
Private Cloud 4.19.06 feature release
Apigee released a feature release (4.19.06).
In addition to bug fixes and security updates, this release includes the following features and enhancements:
- LDAP support for SSO
- HTTP deployment support
- Pluggable analytics
- Cassandra rack support
- IPv6 support
- Simplified New Edge experience installation
- Exclude INVALID_TSC transactions (Monetization)
August 27, 2019
Following are notable doc updates between the previous period and the date above.
Cloud
Hybrid Beta 2
We published documentation for Apigee's Hybrid Beta 2 (with GCP Experience UI) release.
docs-new.apigee.com retired
For a couple of years, while the Edge UI (formerly known as the New Edge Experience) evolved from Beta to GA, we maintained a doc site at docs-new.apigee.com to provide New Edge Experience-specific content and instructions. We've retired docs-new and migrated all its content to docs.apigee.com (this site).
JWS policies
We added reference topics for the JWS policies (JSON Web Signature) introduced in the Edge Cloud 19.03.01 release.
API Analytics: data export and async query
Apigee released the Data Export and Async Query features for general availability, giving API producers more options for capturing, analyzing, and visualizing API program data.
Security Reports
Apigee released a Beta version of the Security Reports feature, giving you insights into the security status of your APIs and providing suggestions for improved security.
API Monitoring
Following are documentation additions for API Monitoring:
- Apigee released the Events Dashboard for general availability, letting you view and drill down on API Monitoring alert notifications.
- API Monitoring includes information about the execution of service callouts in an API proxy flow.
Policy troubleshooting playbooks
We published new troubleshooting topics for the Extension Callout and SAML Assertion policies.
Permissions reference for shared flows
We added a shared flows section to the Permissions reference to help you define specific administrative permissions for shared flows.
Edge Microgateway
We added the following to the Edge Microgateway documentation:
- Explicit instructions on how to get a refresh token
- An error reference for Edge Microgateway to help you troubleshoot runtime errors
AWS integration topics
We removed a legacy set of Amazon Web Services (AWS) integration topics after Apigee provided a better AWS integration solution with Extensions.
Private Cloud
Private Cloud 4.19.01.01 patch release
Apigee released a patch (4.19.01.01) to Edge for Private Cloud version 4.19.01.
June 6, 2019
Following are notable doc updates between the previous period and the date above.
Cloud
Drupal 8 open source modules
We released new modules and updates that let you build and manage developer portals using Drupal 8. A new kickstarter module helps you quickly configure and brand your portal. To get started, see Build your portal using Drupal 8.
Custom role permissions reference
We created a Permissions reference that shows resource paths and permissions you can set when defining custom administrative roles in Edge.
Purge interval for expired OAuth tokens
We updated the OAuthv2 policy topic to reflect the new default 3-day interval at which Edge purges expired OAuth access and refresh tokens. The previous default purge interval was 180 days, which still applies to Edge for Private Cloud versions 4.18.05 and earlier.
Links to Apigee Support
Links to Apigee Support now point to the new support page: https://cloud.google.com/apigee/support/
Security FAQs
We published the following security FAQs:
- OWASP - Guidance on how to use Edge to address OWASP security vulnerabilities. See OWASP protections with Edge—defense in depth.
- Edge public cloud connectivity - Describes why TLS is more secure and scalable than VPN and VPC for securing communication with Edge. See Edge public cloud connectivity (TLS vs. VPN and VPC).
- Apigee's access to your cloud org - Explains the level of access that Apigee has to your cloud organization and describes specific actions you can take to limit some of Apigee's access to your data. See Limit Apigee access to your public cloud organization.
April 9, 2019
Following is a notable doc update released on April 9, 2019.
Apigee Hybrid
We published the docs for the Beta release of Apigee Hybrid, a new deployment option for the Apigee API management platform that lets you host your runtime anywhere—in your data center or the public cloud of your choice. The docs provide all you need to install Apigee Hybrid and get started, including admin tasks, API development tasks, and reference content.
March 25, 2019
Following are notable doc updates between the previous period and the date above.
Cloud
-
API proxy antipatterns
We've published a library of antipatterns that describe what not to do in API proxy development, along with companion best practices to keep your API proxies running smoothly.
-
Developer portal enhancements
Apigee released and documented the following developer portal enhancements for general availability:
- SmartDocs: API reference documentation rendered from OpenAPI specs (versions 2.0 and 3.0.x now supported, including proxy generation).
- A redesigned default portal theme and editor that uses Angular and Google's Material Design toolkit.
- Improvements to how accounts are managed for developers, including username/password support and tools for admins to manage portal users.
This blog post also contains a feature summary.
-
AWS extensions
Edge now has extensions for working with Amazon S3 and AWS Lambda.
-
Set parameters in shared flows
In a FlowCallout policy, which invokes a shared flow, you can set one or more <Parameter> values that can be read by any policy in the shared flow during shared flow execution.
-
Update payment info for Apigee subscription plans
For Apigee subscription plans (such as Team and Business), you can update credit card information or switch from invoice billing to credit card payments in the Edge UI. See Create an Apigee Edge account for instructions.
-
Edge Installer for PCF
We published documentation for version 4.19.01 of Edge Installer for Pivotal Cloud foundry.
Private Cloud
-
Edge installer for Pivotal Cloud Foundry
Apigee released the Edge installer for Pivotal Cloud Foundry version 19.01.
January 28, 2019
Following are notable doc updates between the previous period and the date above.
Cloud
-
Japanese translation of Apigee docs
Much of the Apigee documentation is now available in Japanese. If the language in your browser is set to Japanese, you'll see the translated docs automatically when you visit https://docs.apigee.com. To see the Japanese documentation with browsers set to any language other than Japanese, go to https://docs.apigee.com?hl=ja.
-
Istio Services in API product configuration
Apigee refactored the API product configuration page in the New Edge experience UI. A new Istio Services option lets you bind the API product to one or more Istio Services created using the Apigee Adapter for Istio. See the Manage API products topic for the step describing the Istio Services option.
-
General Availability (GA) release of Monetization in the New Edge experience UI
The GA release of Monetization in the New Edge experience UI is now available. You can manage all monetization tasks in the New Edge experience UI. Documentation additions include:
- Manage companies and developers
- Manage reports
- Configure monetization properties for a company or developer
- Make billing adjustments
With this announcement, monetization variance reports have been officially deprecated. See Apigee deprecations.
Private Cloud
- We created a Quick Start for apigee-monit.
January 3, 2019
Following are notable doc updates between the previous period and the date above.
Cloud
-
Limits updates
We updated the Limits topic, which includes limit increases on key value maps, caches, and target servers.
-
Apigee Edge antipatterns
In the Apigee Community, the Apigee Support team had published The Book of Apigee Edge Antipatterns in PDF format. We've converted that content to HTML, and it is now available on this Apigee doc site at https://docs.apigee.com/api-platform/antipatterns.
-
Virtual host alias wild card
When defining a virtual host alias, you can use a single asterisk wild card at the beginning of the alias; for example,
*.example.com
. This technique lets API proxies handle calls addressed to multiple subdomains such asalpha.example.com
,beta.example.com
, orlive.example.com
. Using a wild card alias also helps you use fewer virtual hosts per environment to stay within product limits, since a virtual host with a wild card counts as only one virtual host. -
Beta release of Apigee Edge module for Drupal 8
The Beta release of the Apigee Edge module for Drupal 8 is now available. Drupal 8 provides a reliable open-source, enterprise-level content management system (CMS). Using the Drupal 8 portal development tools, you can build a fully customizable developer portal. Because Drupal 8 is open-source, you can extend and contribute to the Drupal 8 portal development framework and leverage the knowledge of the Drupal community. For more information, see Build your portal using Drupal 8.
-
General availability (GA) of Apigee Edge Client Library for PHP
The GA release of the Apigee Edge Client Library for PHP for use with Drupal 8 is now available. The SDK makes it easy to write PHP modules that use the Apigee APIs. For more information, see Build a custom portal using Apigee Edge management APIs.
-
TLS for Edge Microgateway running in a Docker container
You can configure northbound and southbound TLS for Edge Microgateway running in a Docker container. See the doc for details.
November 16, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
-
Edge installer for Pivotal Cloud Foundry
You can install Edge for Private Cloud version 4.18.05 on Pivotal Cloud Foundry. See the documentation for more information.
-
X-Forwarded-For IP addresses in Edge
We made the following doc updates to describe changes in how Edge handles the
X-Forwarded-For
HTTP header:- We updated the About the X-Forwarded-For HTTP header in the AccessControl policy reference.
- In the Analytics
metrics, dimensions,and filters reference, we added a new
ax_resolved_client_ip
dimension, which contains the originating client IP address, and updated the behavior descriptions of thex_forwarded_for_ip
andax_true_client_ip
dimensions.
-
Apigee product limits
We've published an initial set of product limits to help guide your API program development on Apigee Edge, and we'll periodically publish addition limits. See Apigee product limits.
-
API Monitoring general availability
API Monitoring is generally available. See the API Monitoring docs.
-
Extensions general availability
Apigee extensions are generally available. See the extensions docs.
-
Hosted targets general availability
Apigee hosted targets are generally available. See the hosted targets docs.
-
Policy error troubleshooting playbooks
We've added a (still-growing) library of troubleshooting playbooks designed to help you better understand and handle errors thrown by Edge policies in your API proxies. See the new policy playbooks.
-
Edge Microgateway for API management in Kubernetes
You can use Edge Microgateway to provide Apigee API management for services running in a Kubernetes cluster. See Integrate Edge Microgateway with Kubernetes.
-
Flow configuration reference
We've completely refactored and improved the content for configuring API proxy flows. See Flow configuration reference.
-
Management APIs for auditing shared flows
Two new management APIs let you see the audit trail for management changes to shared flows.
-
Pass parameters to shared flows
A new
<Parameter>
element in the FlowCallout policy lets you specify one or more values to pass into a shared flow during API proxy execution. -
Monetization features added to the New Edge Experience UI
You can manage additional features in the Beta release of monetization in the New Edge Experience UI. See the 18.09.18 release notes.
-
Apigee Sense user roles
Apigee Sense has introduced new built-in user roles. See Apigee Sense built-in roles.
-
Navigation changes
We've moved the Edge Microgateway docs under the Apigee Edge > Develop section of the doc site (in the top horizontal navigation).
-
docs.apigee.com on DevSite v2
On August 7, 2018, we migrated docs.apigee.com to the DevSite v2 framework for enhanced performance and functionality.
-
Apigee Adapter for Istio 1.0
Apigee released the Apigee Adapter for Istio for general availability. See the documentation.
-
Get RSS notifications for updates
You can subscribe to RSS notifications about documentation updates, such as deprecation announcements, releases, and "What's new in the docs" (this page). To subscribe, see Get Apigee Edge documentation notifications.
-
TLS support
Updated the Supported Software topic to say that Apigee Edge Public Cloud supports only TLS version 1.2.
-
Apigee Extensions Beta
Apigee Extensions Beta is now available. Apigee Extensions provide access from within an API proxy to external resources such as Google Cloud Platform (GCP) services. For a full list of features and benefits, see Apigee Extensions overview documentation at https://docs.apigee.com/api-platform/extensions/extensions-overview.
-
Apigee API Monitoring Beta
Apigee API Monitoring Beta is now available. API Monitoring works in conjunction with Apigee Edge Cloud to provide real-time insights into API operation and performance. For a full list of features and benefits, see API Monitoring documentation at https://docs.apigee.com/api-monitoring.
-
Java permission reference
We've updated the following permissions in the Java permission reference:
Permission Type Target or Action Name Permission Granted java.lang.reflect.ReflectPermission suppressAccessChecks NO java.lang.management.ManagementPermission control NO java.lang.RuntimePermission accessDeclaredMembers NO -
Two-factor authentication for entire organization
We added a section to Enable two-factor auth for your Apigee account that describes how to enable two-factor authentication for individuals or for an entire organization.
-
Getting started
We've improved and consolidated our getting started material with a simple, straightforward, step-based set of topics that has users create an account, then create, modify, and test an API proxy.
CPS caching minimum time
We added the following note about Core Persistence Services (CPS) caching to relevant places in the documentation:
OAuth access tokens and Key Management Service (KMS) entities (Apps, Developers, API Products) are cached for 180 seconds (current default) in organizations with Core Persistence Services enabled. Any custom attributes associated with entities also get cached for at least 180 seconds after entity is accessed during runtime. This also means the
ExpiresIn
element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.-
Management API authentication
You can authenticate with the Apigee management API in multiple ways, and we've consolidated and clarified that content. See Access the management API.
-
TLS 1.0 and 1.1 retirement update
The retirement of TLS 1.0 and 1.1 on Apigee Edge Public Cloud changed to June 29, 2018 for PCI (Payment Card Industry) customers and July 31, 2018 for non-PCI customers.
- Adding and deleting analytics components in analytics groups
- Custom Dimensions not appearing when multiple axgroups have been configured
- New installations:
- New installation overview
- Existing installations:
- Upgrade from 4.18.01
- Upgrade from 4.17.05 or 4.17.09
- Upgrade from 4.17.01
- Upgrade from 4.16.09
- Upgrade from 4.16.01 or 4.16.05
-
Hosted Targets Beta
Hosted Targets (now in Beta release), which replaces the Trireme feature, lets you run Node.js applications in a native, secure, scalable, and isolated environment where Edge API proxies can call them as target services. For more information, see the Hosted Targets documentation.
-
Message templates
Message templates let you dynamically populate strings in certain policy and TargetEndpoint XML elements. While message templating has been available in Edge for a long time, Apigee has released new string manipulation functions for use in message templates. We've created an About message templates topic to give you an overview of message templating, and a Message template function reference that shows you how to use the functions.
-
List Company Apps management API pagination
The List Company Apps management API returns a limit of 100 company apps for organizations with Core Persistence Services (CPS) enabled. We've added two query parameters to the API,
count
andstartKey
, to enable response pagination. -
Apigee Test documentation retired
Apigee Test has been retired, as listed on the deprecations and retirements page. Apigee Test documentation is no longer available. A possible alternative for testing the availability of APIs is Stackdriver Uptime Checks.
-
Secure store (vaults) documentation retired
The Apigee secure store, also known as vaults, has been retired, as listed on the deprecations and retirements page. The secure store documentation is no longer available. The replacement for the secure store is encrypted key value maps (KVMs).
-
KVM names are case sensitive
Key value map (KVM) names/identifiers are case sensitive in organizations with Core Persistence Services enabled. We've updated various topics in the docs to note this.
-
Clear All Cache management API
We removed the "prefix" query parameter from the Clear All Cache Entries management API. The doc incorrectly said the "prefix" query parameter cleared caches with a specific prefix. But the API clears all caches regardless of prefix.
-
Giving Apigee Support access to your Trace sessions
If you need to give Apigee Support access to your Trace sessions for troubleshooting, you must now select the option for that in the Trace tool. For more information, see Apigee Support use of Trace.
-
Privacy and security settings: data protection officer and EU representative
A new Data Protection Officer and EU Representative section in our FAQs describes how to identify a data protection officer and an EU representative for your Edge organization.
-
KVM and API product names case sensitive in CPS
We updated our documentation in various places to note that key value map (KVM) and API product names are case sensitive in organizations that have Core Persistence Services (CPS) enabled. Be sure to use the exact case of names in places like policy configuration and management API calls.
-
Distributed Spike Arrest
Spike Arrest counts can be automatically distributed across message processors when using auto-scaling groups. You do this with the
UseEffectiveCount
element. For more information, see the Spike Arrest policy documentation. -
Self-service TLS and virtual hosts
We published documentation for the general availability release of self-service TLS and virtual hosts.
-
Removed parallel deployment of API proxy revisions content
In the Deploying proxies in the UI topic, we removed the section, "Deploying multiple versions of an API proxy to the same environment," as deploying multiple revisions of an API proxy in parallel by changing the base path is not a best practice.
-
Management API: List API Products count and startKey
The List API Products management API topic now includes pagination query parameters for
count
andstartKey
. These query parameters are available only in organizations that have Core Persistence Services (CPS) enabled. -
Concurrent Rate Limit policy and DefaultFaultRule
In the Concurrent Rate Limit policy topic, we note that the policy is also required in the DefaultFaultRule to ensure that the rate limit counters are maintained correctly in the event of an error.
-
Analytics prerequisites
We created a First things first: How to generate complete analytics data section in the Analytics Overview topic to explain why you might not see all the analytics data you expect to see.
-
Management API: Get KVMs
The Get KeyValueMap management APIs in organizations enabled with Core Persistence Services (CPS) behave differently than in non-CPS-enabled organizations. For details, see the "Get KeyValueMap APIs" section of the CPS retirements and changes.
-
4.18.01 release
We published documentation for the Edge for Private Cloud 4.18.01 release.
-
Management API traffic limit
We've published a traffic limit for the Edge management API. Each organization on a paid plan is limited to 10,000 management API calls per minute, and trial organizations are allowed up to 600 calls per minute.
-
List apps by app status API
The API documentation titled "List App IDs in an Organization by Key Status" was incorrect and has been changed to List App IDs in an Organization by App Status. The API returns a list of apps by app status (approved or revoked). The previously documented "pending" status has been removed from the topic.
-
Error troubleshooting topics
We've begun creating a library of troubleshooting topics for errors you might receive when using Apigee. The topics provide detailed information about possible causes and potential fixes you can try. For more information, see Troubleshoot Apigee errors.
-
4.17.09 Edge for Private Cloud installer on Pivotal Cloud Foundry
For more information, see Edge Installer for Pivotal Cloud Foundry.
-
New Edge portal custom domain configuration
Enhancements have been made to the portal custom domain configuration process to facilitate self-service and improve performance. For more information, see Customizing your domain name. (69604000)
-
Japanese doc translations
The Japanese version of the Apigee documentation, formerly located at ja.docs.apigee.com, will be offline for a few months while we transition to a new documentation and translation framework. We apologize for the inconvenience. However, the good news is that when the translated content returns, there will be more of it than we previously had.
-
Trial org migration script
You can migrate code in your Apigee Edge organization from one trial org to another. Using the Apigee migrate tool, you can migrate most of the code, leaving just a few pieces to copy over manually. For details, see Migrating data from an Apigee trial org. (67179631)
-
Frequently asked questions (FAQ) on security, compliance, and other topics
We published the following new FAQ topics:- DDoS defense in Edge
- Customer security testing requests
- Anti-malware and Apigee Edge Cloud
- Reporting vulnerabilities in Edge
- Edge network design and firewalls
- Performance testing
- Business Continuity Planning and Disaster Recovery
- Apigee Edge backups
(68254885)
- AWS "Dedicated Instances" for HIPAA compliance deprecation
announcement
Apigee announced the deprecation of AWS Dedicated Instances for HIPAA compliance. For more information, see Apigee deprecations and retirements. (68660828) - Concurrent Rate Limit policy and DefaultFaultRule
Updated the ConcurrentRateLimit policy to state that the policy is also required in the DefaultFaultRule to ensure that the rate limit counters are maintained correctly in the event of an error. (68161202) - Automated sign-up for new evaluation accounts
The sign-up process for new evaluation accounts is now automated. New evaluation accounts are provisioned in minutes instead of hours in fewer steps. For more information, see Creating an Apigee Edge account. (66191481) - Update naming restrictions for Target Servers and keystores
The names of keystores and TargetServers cannot contain special characters. Only alphanumeric characters are allowed. The docs have been updated to reflect this. (DOC-2336) - Analytics: Download charts from Analytics dashboards in CSV format
You can now download all of the charts on the analytics dashboards using CSV format. On each analytics dashboard, click Combined CSV to download a single CSV file that contains a combined set of data from all charts on the page. Alternatively, click CSV adjacent to a chart to download data specific to that chart only. (DOC-2318) - 17.07.31 API Management and API Runtime release notes
/release-notes/content/170731-apigee-edge-public-cloud-release-notes-api-management-and-runtime - 17.08.02 UI release
17.08.02 - Apigee Edge for Public Cloud release notes (UI) and https://docs-new.apigee.com/release-notes#release17080200 - Location for setting max number of open file descriptors
On Message Processor nodes, set the maximum number of open file descriptors to 64K in /etc/security/limits.conf, not by using the ulimit command as was previously shown at System limits. (DOC-2296) - Document API for managing monetization scheduled jobs
In the section, Manage the monetization job schedule using the API, we added a note saying that Apigee Edge Private Cloud customers with system admin privileges can manage the monetization job schedule using the API. Apigee Edge Cloud customers should contact their Apigee Support representative for assistance with managing the monetization job schedule. (DOC-2269) - ConcurrentRateLimit performance overhead
Added a note to the ConcurrentRateLimit policy topic saying that use of the policy has performance overhead. (DOC-2228) - Port for Developer Services portal on Apache
Updated the procedure to change the port used by the Developer Services portal when deployed on Apache. You must also update /etc/httpd/conf/vhosts/devportal.conf when changing the port number. See Set the HTTP port. (DOC-2209) - Stop and start order for Private Cloud components
Updated the order that you use to stop and start Edge for Private Cloud components. See Starting, stopping, restarting, and checking the status of Apigee Edge for the updated order. (DOC-2176) -
HIPAA & PCI compliance
Published documentation on HIPPA and PCI compliance.- HIPPA: HIPAA Configuration Guide for Edge Public Cloud
- PCI: PCI Configuration Guide for Edge Public Cloud
(DOC-2027)
- The default timeout on MPs is 55s seconds, not 120s
The value default ofio.timeout.millis
on message processors was incorrectly listed as 120000 (120 seconds). The actual default value is 55000 (55 seconds). See Endpoint properties reference for more. (DOC-2104) - Javadocs on GitHub now include definition of dependent classes and/or
interfaces
For classes that can be used in Java Callouts, we updated the Javadoc to include dependent classes. We also updated the java* samples in GitHub and the JavaCallout policy reference documentation. (DOC-225) - 17.05.22 Management API release notes
Published release notes for the 17.05.22 API Management cloud release. (DOC-2122) - Update to consumer key and secret naming rules
Per Apigee for Public Cloud release 17.05.22 for API management, consumer key and secret naming rules have changed in the management API documentation. The docs now say, "Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed." (DOC-2042) - Unpublish external-role-mapping topic
Removed documentation for the External Role Mapping feature of the external authentication mechanism pending updates to this feature. (DOC-2056) - Drupal developer portal root directory in Private Cloud 4.17.05
The root directory of Drupal for the Developer Service portal for the 4.17.05 Private Cloud Release now uses/opt/apigee/apigee-drupal/wwwroot
as the root directory, replacing/opt/apigee/apigee-drupal
. (DOC-2181) - Edge 4.17.05 installer for Pivotal Cloud Foundry
On Tuesday, June 20, 2017, we released the Apigee Edge for Private Cloud Installer for Pivotal Cloud Foundry. See Edge Installer for Pivotal Cloud Foundry for more information. (DOC-2023) - Analytics: Update metrics and dimension definitions
Updated the Analytics metrics, dimensions, and filters reference with definitions of analytics metrics and dimensions. (DOC-377) - Drupal Dev Portal Default URL: *.devportal.apigee.io
The default URL for Drupal developer portals has changed from:
http://{environment}-{your-org-name}.devportal.apigee.com/
to:
http://{environment}-{your-org-name}.devportal.apigee.io/
For more information, see Creating a developer portal. (DOC-2108) - Fix 'XSLT pagination' sample proxy
Fixed the XSLT pagination sample proxy to use a local proxy as a target, replacing the broken target. (DOC-2107) - Added documentation on Router troubleshooting
The Edge Router is implemented by using the NGINX router. We have added new documentation on troubleshooting the Router during configuration and update. See Bad config files. (DOC-2018) - Document requirement to disable IPv6 on Google Cloud Platform for RedHat/CentOS
7
If you are installing Edge on RedHat 7 or CentOS 7 on Google Cloud Platform, then you must disable IPv6 on all Qpid nodes. See the RedHat or CentOS documentation for your specific OS version for instructions on disabling IPv6. (DOC-2047) - New installer and command syntax for the apigee-analytics-collector
utility
Added documentation for the new installation instructions and command syntax for the apigee-analytics-collector utility. You now useapigee-service
to install the apigee-analytics-collector utility, instead ofnpm
, and invoke the apigee-analytics-collector utility throughapigee-service
. See Uploading API Traffic Data to Apigee (Beta). (DOC-2060) - Updated doc for enabling JMX
The Edge for Private Cloud doc incorrectly specified that JMX was enabled by default for Edge components. However, JMX is only enabled by default for Cassandra. To enable JMX for other components, see the updated documentation at Enabling JMX authentication and setting the JMX password.(DOC-2055) - Private Cloud 4.17.05 documentation
We released the documentation for Apigee Edge for Private Cloud Version 4.18.01. See the release notes at 4.17.05 - Edge for Private Cloud release notes. (DOC-2058) - Set
isEnabled
default to "true" for Update TargetServer API - The default value for
isEnabled
is now correctly shown as 'true' in the property descriptions of the Update TargetServer API. (DOC-1889) - Offset parameter on the /stats API ignored on raw "fact" queries
With the /stats management API, which gets metrics for a dimension, theoffset
pagination query parameter description includes a new note that the parameter is ignored if the Spark engine is used to process a "fact" query. (DOC-1977) -
Managing the audience for your portal and its contents
The New Edge UI documentation contains a new section on managing the audience for your portal and its contents. Specifically, you can:
- Restrict the audience for your portal by identifying the individual email addresses (developer@some-company.com) or email domains (@some-company.com) that can create accounts. See Managing the audience for your portal.
- Manage the audience for your page in your portal by allowing access to all users or registered users only. See Managing the audience for a page in your portal.
- Manage the audience for an API product on your portal by allowing access to all users or registered users only. See Managing the audience for an API product on your portal.
(DOC-1993)
- Add MP ports to multi-Data Centers image
The port diagram for multiple data centers now shows that port 4528 must be open on all Message Processors across data centers. See Edge port requirements. (DOC-1997) - Create docs for Acquia Drupal (for EU customers)
Apigee now uses Acquia, a web site management service, for hosting cloud-based versions of the Developer Services portal in the European Union (EU). Acquia is designed to work with Drupal to let you develop, test, and publish your portal in a secure environment. For more information, see Working with Acquia. (DOC-1952) - Clarify the description of cache behavior
In the Cache internals topic, we corrected some information and clarified caching behavior between message processors. (DOC-1973) - Mark Apigee Test as an Apigee Labs project
Apigee Test is an Apigee Labs product. We've added a banner to the Apigee Test topics indicating this, and we moved the Apigee Test topics to a newApigee Labs section in the docs. (Note: This feature is retired.) (DOC-1884) - Update Message Logging policy reference to describe Edge Private Cloud directory
structure
Updated the doc for the MessageLogging policy to describe the log file location for Edge for Private Cloud and how to configure it. (DOC-1844) - Use IP addresses when configuring Cassandra nodes
Updated multiple Edge for Private Cloud topics to indicate that you must use IP addresses in the config files to identify Cassandra nodes. You cannot use DNS names. (DOC-1985) - Replace metadata size with permgen size
Updated Modifying Java Memory Settings to note that permgen size was replaced in Java 1.8 with class metadata size. (DOC-1962) - 10MB as default message payload size
Updated the Edge Private Cloud docs to show 10MB as the default message payload size. For example, see the 4.17.01 doc (DOC-1933). - Property ws.acceptAnyCertificate changed to
play.ws.ssl.loose.acceptAnyCertificate
In the Edge Private Cloud 4.17.01 doc for Configure the Edge UI to use TLS to access the Edge API, theconf/application.conf+ws.acceptAnyCertificate
property has been changed toconf/application.conf+play.ws.ssl.loose.acceptAnyCertificate
. (DOC-1926)
October 26, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
August 10, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
July 27, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
June 29, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
Edge for Private Cloud
Troubleshooting playbooks for Edge for Private Cloud
We've added the following new playbooks for troubleshooting issues on Edge for Private Cloud:
June 1, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
Monetization in the New Edge experience UI Beta
The Beta release of Monetization in the New Edge experience UI is now available. For more information, see Monetizing your APIs.
Only a subset of features are supported in the new Edge experience for the Beta release. Features that are supported only using the Classic UI or monetization API are noted in the documentation.
Edge for Private Cloud
Edge for Private Cloud v4.18.05 has been released:
May 4, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
April 20, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
April 6, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
March 23, 2018
Following are notable doc updates between the previous period and the date above.
Cloud
Private Cloud
December 15, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
December 1, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
November 17, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
November 3, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
October 6, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
August 25, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
August 11, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
Private Cloud
July 28, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
July 14, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
Private Cloud
June 30, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
Private Cloud
June 16, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
Private Cloud
June 2, 2017
Following are notable doc updates between the previous period and the date above.
Private Cloud
May 19, 2017
Following are notable doc updates between the previous period and the date above.
Cloud
Private Cloud
May 5, 2017
Following are notable doc updates between the previous period and the date above.