What's new in the docs

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.

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:

  • October 26, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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).

    August 10, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    July 27, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    June 29, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    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:

    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

    May 4, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    April 20, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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 and startKey, 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.

    April 6, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    March 23, 2018

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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 and startKey. 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.

    Private Cloud

    • 4.18.01 release

      We published documentation for the Edge for Private Cloud 4.18.01 release.

    December 15, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    December 1, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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.

    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

    • 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, retirements, and CPS changes. (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)

    October 6, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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)

    August 25, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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)

    August 11, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    Private Cloud

    • 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)

    July 28, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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)

    July 14, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • ConcurrentRateLimit performance overhead
      Added a note to the ConcurrentRateLimit policy topic saying that use of the policy has performance overhead. (DOC-2228)

    Private Cloud

    • 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)

    June 30, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    Private Cloud

    • 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)

    June 16, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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)

    Private Cloud

    • 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 use apigee-service to install the apigee-analytics-collector utility, instead of npm, and invoke the apigee-analytics-collector utility through apigee-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)

    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

    • 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, the offset 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:

      (DOC-1993)

    Private Cloud

    • 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)

    May 5, 2017

    Following are notable doc updates between the previous period and the date above.

    Cloud

    • 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)

    Private Cloud

    • 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, the conf/application.conf+ws.acceptAnyCertificate property has been changed to conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate. (DOC-1926)