UI overview

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Note: This topic provides an overview of the Apigee UI in Cloud console. The majority of the features and functionality of the Classic Apigee UI have been migrated to the Apigee UI in Cloud console to provide a seamless experience when managing your full suite of Cloud products. We recommend migrating to the Apigee UI in Cloud console to take advantage of each new feature release, as new features will not be supported in the Classic Apigee UI.

For a map of feature locations and availablility in each UI, see Apigee UI in Cloud console navigation.

The Apigee UI is a graphical user interface that you can use to manage the lifecycle of your APIs. You can use the Apigee UI to develop and deploy your API proxies, trace their execution, view API analytics, and manage other aspects of your Apigee organization and its environments. You can access the Apigee UI in the Google Cloud console, making it easier to access and manage Apigee while working with other Google Cloud resources.

Using the Apigee UI, you can:

• Build an API proxy
• Deploy and undeploy API proxies to your cluster
• Create, edit, and delete environments and environment groups
• Assign environment-level access control to users
• Work with target servers, KVMs, and shared flows

Use the Apigee UI in Cloud console

To open the Apigee UI in the Google Cloud console, go to the Apigee API management page.

Apigee API management

From the Overview page, you can:

• Get started as a new Apigee user
• Test your Apigee runtime
• View key resource usage metrics
• Explore Apigee API management features

Get started as a new Apigee user

If you just are new to Apigee, you can begin your API management journey with quickstart learning options launched from the Overview page:

• Begin by deploying your first proxy: Watch a video tutorial that walks you through the steps required to create and deploy an API proxy. Once you are ready, click Create new proxy to get started.
• Start with VS Code: Follow this step-by-step tutorial to Build and deploy your first API proxy locally using Apigee in VSCode.

For more advanced use cases, follow along with step-by-step video walkthroughs showcased in the Tutorials section of the page:

Test your Apigee runtime

If you just completed provisioning a new Apigee organization, use the Test your Apigee runtime card to deploy and call a proxy, as described below:

Pay-as-you-go organization

If you have a Pay-as-you-go organization:

1. Click Deploy API to deploy the sample Hello World proxy to the test-env environment in your new runtime instance.
   Note: The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.
2. Upon successful deployment, the console displays steps for sending a test request.

Subscription organization

If you have a Subscription organization:

1. Configure DNS to enable external access to your new proxy For more information, see Call the proxy with external access.
2. Click Deploy API to deploy the sample Hello World proxy to the default-dev environment in your new runtime instance.
   Note: The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.
3. Upon successful deployment, the console displays steps for sending a test request.

View key resource usage metrics

You can view key usage metrics for your organization at a glance using the Proxy Usage and Environment Usage cards on the Overview page. The cards display the following metrics:

• Proxy Usage:
  • Total proxies created: The total number of API proxies created, including deployed and undeployed proxies.
  • Proxies deployed: The total number of API proxies deployed across all environment(s) in the organization.
  • Proxy deployment units: The total number of API proxy and shared flow revisions deployed in your organization. Each deployment per environment, per instance, is counted as one unit.
  • Proxies and shared flows deployed against limit: Total number of API proxies and shared flows deployed in the organization, against the limit for your organization type.
  • Extensible deployment units: The number of extensible API proxy revisions deployed in your organization. Each deployment per environment, per instance, is counted as one unit.
  • Standard deployment units: The number of standard API proxy revisions deployed in your organization. Each deployment per environment, per instance, is counted as one unit.
• Environment Usage:
  • Total environments: The total number of active and inactive environments in the organization.
  • Active environments: The total number of environments attached to a minimum of one Apigee instance.

Note: If your organization is Apigee hybrid-enabled, only a sub-set of these usage metrics are displayed.

Whether you are a Pay-as-you-go or Subscription customer, this view provides you with a snapshot of key resource usage, as well as shortcuts to other monitoring and identity management resources for your organization, including:

• Cloud Monitoring
• Cloud Billing
• Identity and Access Management

Explore Apigee API management features

From the main navigation menu, you can explore the range of Apigee API management features available for your organization, as described in the table below:

Main navigation menu	Purpose
Proxy development	Develop and deploy API proxies.
Distribution	Make your APIs available to app developers.
Analytics	Analyze API traffic data.
API security	Identify security threats and vulnerabilities with Advanced API Security.
API hub	View and manage your organization's APIs with API hub (Preview).
Management	Manage Apigee users and roles.

Apigee UI in Cloud console navigation

If you are an existing Apigee user, you may be accustomed to navigating the Classic Apigee UI to perform the tasks you complete most frequently. Apigee is now available in the Google Cloud console, and the Classic Apigee UI is shutting down as described in Feature deprecations. Apigee in the Google Cloud console gives you the ability to manage all of your Apigee functionality in one place.

During the transition, selecting the Classic Apigee UI navigation menu items will redirect you to the Apigee UI in Cloud console equivalent page. Until the Classic Apigee UI is shut down, you can still access the Classic Apigee UI page directly by navigating to the URL for the page as shown in the following table:

The following table maps each Classic Apigee UI feature page to its location in the Apigee UI in Cloud console:

Feature	Classic Apigee UI	Apigee UI in Cloud console
Proxies	Develop > API proxies Direct link: https://apigee.google.com/organizations/ORG_NAME/proxies	Proxy development > API proxies Go to API proxies
Sharedflows	Develop > Sharedflows Direct link: https://apigee.google.com/organizations/ORG_NAME/sharedflows	Proxy development > Sharedflows Go to Sharedflows
Offline debug	Develop > Offline debug Direct link: https://apigee.google.com/organizations/ORG_NAME/offline-debug	Proxy development > Offline debug Go to Offline debug
API products	Publish > API products Direct link: https://apigee.google.com/organizations/ORG_NAME/apiproducts	Distribution > API products Go to API products
Portals	Publish > Portals Direct link: https://apigee.google.com/organizations/ORG_NAME/portals	Distribution > Portals Go to Portals
Monetization	Publish > Monetization Direct link: https://apigee.google.com/organizations/ORG_NAME/monetization/rate-plans	Distribution > Monetization Go to Monetization
Developers	Publish > Developers Direct link: https://apigee.google.com/organizations/ORG_NAME/developers	Distribution > Developers Go to Developers
Apps	Publish > Apps Direct link: https://apigee.google.com/organizations/ORG_NAME/apps	Distribution > Apps Go to Apps
API monitoring	Analyze > API monitoring Direct link: https://apigee.google.com/organizations/ORG_NAME/apimonitoring/timeline https://apigee.google.com/organizations/ORG_NAME/apimonitoring/recent https://apigee.google.com/organizations/ORG_NAME/apimonitoring/investigate	Proxy development > API monitoring Go to API monitoring
API metrics	Analyze > API metrics Direct link: https://apigee.google.com/organizations/ORG_NAME/analytics/proxy-performance https://apigee.google.com/organizations/ORG_NAME/analytics/cache-performance https://apigee.google.com/organizations/ORG_NAME/analytics/error-analysis https://apigee.google.com/organizations/ORG_NAME/analytics/latency https://apigee.google.com/organizations/ORG_NAME/analytics/target-performance	Analytics > API metrics Go to API metrics
Developer Engagement	Analyze > Developers > Developer Engagement Direct link: https://apigee.google.com/organizations/ORG_NAME/analytics/developer-engagement	Analytics > Developer analysis Go to Developer analysis
Traffic Composition	Analyze > Developers > Traffic Composition Direct link: https://apigee.google.com/organizations/ORG_NAME/analytics/traffic-composition	Analytics > Developer analysis Go to Developer analysis
Devices	Analyze > End Users > Devices Direct link: https://apigee.google.com/organizations/ORG_NAME/analytics/devices	Analytics > End user analysis Go to End user analysis
Geomap	Analyze > End Users > Geomap Direct link: https://apigee.google.com/organizations/ORG_NAME/analytics/geomap	Analytics > End user analysis Go to End user analysis
Custom reports	Analyze > Custom reports Direct link: https://apigee.google.com/organizations/ORG_NAME/analytics/custom-reports	Analytics > Custom reports Go to Custom reports
Instances	Admin > Instances Direct link: https://apigee.google.com/organizations/ORG_NAME/instances	Management > Instances Go to Instances
Data collectors	Admin > Data collectors Direct link: https://apigee.google.com/organizations/ORG_NAME/datacollectors	Management > Data collectors Go to Data collectors
Environments	Admin > Environments Direct link: https://apigee.google.com/organizations/ORG_NAME/environments	Management > Environments Go to Environments
Endpoint attachments	Admin > Endpoint attachments Direct link: https://apigee.google.com/organizations/ORG_NAME/endpointAttachments	Management > Endpoint attachments Go to Endpoint attachments
Roles	Admin > Roles	IAM > Roles Go to Roles
Users	Admin > Users	IAM Go to IAM