UI overview

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

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:

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

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 < a href="https://www.youtube.com/watch?v=79eUi6toj2c">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:

Tutorials in the Apigee UI Overview 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.
  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.
  3. Upon successful deployment, the console displays steps for sending a test request.

View key resource usage metrics

View key usage metrics for your organization at a glance using the Proxy Usage and Environment Usage cards, as shown in the figure below:

resource usage shown in overview

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:

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. You may notice that most 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. New features will not be supported in the Classic Apigee UI.

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
API products Publish > API products Distribution > API products

Go to API products

Portals Publish > Portals Only available in the Classic UI
Monetization Publish > Monetization Only available in the Classic UI
Developers Publish > Developers Distribution > Developers

Go to Developers

Apps Publish > Apps Distribution > Apps

Go to Apps

API monitoring Analyze > API monitoring Proxy development > API monitoring

Go to API monitoring

API metrics Analyze > API metrics Analytics > API metrics

Go to API metrics

Developer Engagement Analyze > Developers > Developer Engagement Only available in the Classic UI
Traffic Composition Analyze > Developers > Traffic Composition Only available in the Classic UI
Devices Analyze > End Users > Devices Only available in the Classic UI
Geomap Analyze > End Users > Geomap Only available in the Classic UI
Custom reports Analyze > Custom reports Analytics > Custom reports

Go to Custom reports

Instances Admin > Instances Management > Instances

Go to Instances

Data collectors Admin > Data collectors Management > Data collectors

Go to Data collectors

Environments Admin > Environments Management > Environments

Go to Environments

Endpoint attachments Admin > Endpoint attachments Management > Endpoint attachments

Go to Endpoint attachments

Roles Admin > Roles IAM > Roles

Go to Roles

Users Admin > Users IAM

Go to IAM