This page applies to Apigee and Apigee hybrid.
Registering an API makes it discoverable by viewers on the APIs list.
Register an API
To register an API:
In the Google Cloud console, go to the API hub page.
The APIs list page is displayed by default.
- Click Register API. The Register API pane opens.
- Specify the following API details:
- ID: An identifier for an API resource. The ID can contain only lowercase letters,
numbers, and hyphens. The ID must be unique in the project. IDs must be between 4 and 63
characters long. IDs cannot be changed once an API is registered. For example,
for the API resource name:
projects/my-project/locations/global/apis/my-api
, the resource ID ismy-api
. - Name: Enter the API name
- Description: Enter the API description
- Style:
- Style: Select the primary architectural style of the API (for example, OpenAPI, GraphQL, AsyncAPI, etc, depending on how API hub has been configured).
- API description document: If you have an existing description document, click Browse to upload it. This can be a single file or a zip file (2 MB max). For information on adding and deleting revisions, see Manage revisions.
- MIME type: Select a MIME type. MIME type is displayed after you select an API description document. If you select Other, a text field is displayed where you can manually specify the MIME type.
- Current version:
- Version ID: A name for an API resource. The Version ID can contain only lowercase letters, numbers, and hyphens. The Version ID must be unique in the project. Version IDs must be between 1 and 63 characters long. Version IDs cannot be changed once an API is registered.
- Version: Enter the initial version
- API lifecycle stage: Select a lifecycle stage from the list.
- Expected end of life:
- Select an Expectation from the list.
- If Expectation is Minimum date, specify a Date.
- If Expectation is Confirmed date, specify a Date.
- Properties:
- System taxonomies:
Target users: Select the intended users (consumers) for the API
- Team: Select the team responsible for producing the API
- Business unit: Select the business unit responsible for the API
- Custom taxonomies:
- Select any other custom taxonomies listed
- System taxonomies:
- Primary contact:
- Primary contact email address: The primary contact email address for questions on the API
- Primary contact description: The description of the primary contact
- ID: An identifier for an API resource. The ID can contain only lowercase letters,
numbers, and hyphens. The ID must be unique in the project. IDs must be between 4 and 63
characters long. IDs cannot be changed once an API is registered. For example,
for the API resource name:
- Click Register API (or Cancel).
Edit API registration details
To edit API registration details:
In the Cloud console, go to the API hub page.
The APIs list page is displayed by default.
- Click an API. The API Overview page opens.
- Click Edit.
- Modify details.
- Click Save (or Cancel).
Delete API
Deleting an API removes it from the system. If the API might be of historic interest to others, instead of deleting it, consider using a lifecycle stage of Retired or Deprecated.
To delete an API:
In the Cloud console, go to the API hub page.
The APIs list page is displayed by default.
- Click an API. The API Overview page opens.
- Click Delete API.
A confirmation dialog is displayed. Type the API name and then click Confirm (or Cancel).