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:
- 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.
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:
- Click Deploy API to deploy the sample
Hello World
proxy to thetest-env
environment in your new runtime instance. - Upon successful deployment, the console displays steps for sending a test request.
Subscription organization
If you have a Subscription organization:
- Configure DNS to enable external access to your new proxy For more information, see Call the proxy with external access.
- Click Deploy API to deploy the sample
Hello World
proxy to thedefault-dev
environment in your new runtime instance. - 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.
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 |
Portals | Publish > Portals | Only available in the Classic UI |
Monetization | Publish > Monetization | Only available in the Classic UI |
Developers | Publish > Developers | Distribution > Developers |
Apps | Publish > Apps | Distribution > Apps |
API monitoring | Analyze > API monitoring | Proxy development > API monitoring |
API metrics | Analyze > API metrics | Analytics > 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 |
Instances | Admin > Instances | Management > Instances |
Data collectors | Admin > Data collectors | Management > Data collectors |
Environments | Admin > Environments | Management > Environments |
Endpoint attachments | Admin > Endpoint attachments | Management > Endpoint attachments |
Roles | Admin > Roles | IAM > Roles |
Users | Admin > Users | IAM |