gcloud CLI for API hub

This page applies to Apigeeand Apigee hybrid.

View Apigee Edge documentation.

This page describes how to install, authorize, and use the gcloud CLI for API hub.

The gcloud CLI apihub component lets you to manage your API resources within API hub directly from the command line. This includes registering APIs, creating versions and specifications, managing deployments, and configuring attributes or plugins

Before you begin

Install Google Cloud SDK . Alternatively, you can use the Google Cloud Shell , which comes with the SDK pre-installed.

Authorize access to gcloud CLI

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:

gcloud CLI init

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

Set up environment variables for gcloud CLI commands

Using environment variables can simplify your CLI commands. The following variables are commonly used in API hub operations:

Use the gcloud CLI

The basic structure for API hub commands is as follows:

gcloud CLI apihub  GROUP 
 
[  gcloud CLI_WIDE_FLAG 
 
…]

Common command groups

The following table lists some common command groups for the gcloud CLI apihub CLI.

For more information about the available command groups and flags, see gcloud CLI apihub .

Command examples

The following examples show how to use common gcloud CLI apihub

• Registering an API

  gcloud CLI apihub apis create --api="my-api" --display-name="My New API" --project=$PROJECT --location=$LOCATION

• Listing APIs

  gcloud CLI apihub apis list --project=$PROJECT --location=$LOCATION

• Adding a version to an API

  gcloud CLI apihub apis versions create "v1" --api="my-api" --display-name="Version 1.0" --project=$PROJECT --location=$LOCATION

  You can specify the version as a positional argument or using the --version flag.

• Uploading a specification

  gcloud CLI apihub apis versions specs create "openapi-spec" --api="my-api" --version="v1" --display-name="OpenAPI 3.0 Spec" --contents='{"openapi": "3.0.0", ...}' --contents-mime-type="application/json" --project=$PROJECT --location=$LOCATION

Considerations

• Creating resources without specifying an ID is not supported in the CLI.
• The --filter flag performs client-side filtering. gcloud CLI fetches all resources from the backend and then filters them locally, which may impact performance for large collections.
• For the apis create and update commands, you must use the --api flag to specify the resource ID. Positional arguments for IDs are not supported for the top-level API resource.