Manage custom plugins

This page applies to Apigee and Apigee hybrid.

This page describes how to delete, get, and list custom plugins in API hub. For information about creating a custom plugin, see Create custom plugins.

Before you begin

• Grant the following IAM permissions to your principal account:
  • apihub.plugins.create
  • apihub.plugins.delete
  • apihub.plugins.get
  • apihub.plugins.list

  For information on granting roles to principals, see Granting, changing, and revoking access.

• Ensure that you have deleted all the plugin instances associated with the plugin that you want to delete. See Delete a plugin instance.

Delete a custom plugin

Warning: Deleting a plugin also deletes all the associated data from API hub.

Console

To delete a custom plugin, do the following:

1. In the Google Cloud console, go to the API hub page.

   Go to API hub

2. Click Settings from the left navigation menu to open the Settings page.
3. Click the Plugins tab to view the available custom plugin cards in your project.
4. For the plugin that you want to delete, click (Delete plugin).
5. In the confirmation dialog, click Delete to confirm the deletion of the plugin.

REST API

To delete a custom plugin, do the following:

Send a DELETE request to the plugins resource:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" 
https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/HUB_LOCATION/plugins/PLUGIN_ID

Replace the following:

• PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
• HUB_LOCATION: The location of the API hub.
• PLUGIN_ID: The ID of the plugin.

Get a custom plugin

REST API

You can use the plugin ID to get a specific custom plugin. To get a custom plugin, send a GET request to the plugins resource:

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" 
https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/HUB_LOCATION/plugins/PLUGIN_ID

Replace the following:

• PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
• HUB_LOCATION: The location of the API hub.
• PLUGIN_ID: The ID of the plugin.

List custom plugins

REST API

To list all the custom plugins in your project, do the following:

Send a GET request to the plugins resource:

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" 
https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/HUB_LOCATION/plugins

Replace the following:

• PROJECT_ID: The name of your API hub host project. The host project was selected when API hub was provisioned.
• HUB_LOCATION: The location of the API hub.

What's next

• Learn how to Create custom plugins.
• Learn more about Plugins overview.