viewing Apigee X documentation.
View Apigee Edge documentation.
gcloud apigee CLI enables you to perform the following:
- View API proxies
- Create and manage API products
- Deploy and undeploy API proxies, and view deployment details
- View information about developers and apps
- List your environments and organizations
- Manage third-party applications that call Apigee API proxies
In addition, the
gcloud beta apigee CLI enables you to deploy and manage archives in your Apigee environment.
The following sections describe how to install, authorize, and use the
gcloud apigee and
gcloud beta apigee CLIs, and optionally set environment variables.
Before you begin
Installing the gcloud beta apigee components
To access the
gcloud beta apigee commands, you must install the
complete gcloud beta component, as follows:
gcloud components install beta
To confirm that the beta component has been installed, enter the following command:
gcloud components list
You should see the beta component in the list, as follows:
|Installed||gcloud Beta Commands||beta||< 1 MiB|
For more information, see Managing SDK components.
Authorizing access to gcloud
Authorize access to the
gloud CLI by following the steps described in
Authorizing Cloud SDK tools.
For example, to authorizes access using your user account and perform other common Cloud SDK setup steps, use the following command:
Follow the prompts to authenticate the account, grant access permissions, and initialize your Cloud SDK installation, as described in Initializing Cloud SDK.
Alternatively, to authorize access without performing any additional set up, use the following command:
gcloud auth login
Follow the browser-based authorization flow to authenticate the account and grant access permissions.
For more information about authorizing and revoking access to the gcloud CLI, see Credentials.
Setting environment variables for gcloud commands
The Apigee API and gcloud CLI examples provided throughout the documentation use one or more of the environment variables defined in the following table.
By setting the environment variables upfront to meaningful values in your environment, you can copy and paste the example requests to execute them in your own environment with minimal or no modifications.
||Name of your API proxy.|
||Name of the API product.|
||ID of an app.|
||Email address of the developer.|
||Name of your environment, such as |
||Name of your resource.|
||Your Apigee organization.|
||Revision number of your API proxy.|
||Name of your shared flow.|
Using the gcloud CLI
gcloud CLI as follows:
gcloud apigee GROUP [GCLOUD_WIDE_FLAG …]
For more information about the available command groups and flags, see gcloud apigee.
For example, the following command lists the API proxies in your organization:
gcloud apigee apis list --organization=$ORG
The following provides an example of the response for the
Using Apigee organization `myorg` - hello-world - weather-app
For more information, see:
- gcloud apigee
- gcloud beta apigee
- gcloud command-line tool overview
- Managing SDK components
- Scripting gcloud CLI commands