Skip to main content

View plugin details

The Plugins screen lists the plugins of the API Gateway selected in the top-right corner.

View the plugin list​

  1. In the left menu, select API Gateway → Plugin, then select the API Gateway in the top-right corner.

Plugins screen with the plugin list

The list has the following columns:

ColumnDescription
NamePlugin type with its icon, for example JWT Auth. Click it to open the detail screen.
IDPlugin identifier.
Display NameYour name for the plugin.
TypePlugin group: Authentication, Security, Traffic Control, Transformation.
Applied toScope: Global, Route, Service, or Route + Service.
EnabledSwitch to enable or disable the plugin directly in the table. See Enable or disable a plugin.
OrderingExecution order of the plugin.
Created ByWho created the plugin.
Created AtWhen the plugin was created.
⋮Actions on each row, see the action table below.

The toolbar has the Search box to find plugins by name, the New plugin button to add a plugin, and the Column button to choose, hide, and order the columns. The Refresh button in the top-right corner reloads the list.

The ⋮ menu at the end of each row has 3 actions:

ActionDescription
UpdateOpens the plugin update screen. See Edit a plugin.
Disable / EnableDisables an enabled plugin, or enables a disabled one. See Enable or disable a plugin.
DeleteDeletes the plugin. See Delete a plugin.

Plugin action menu with Update, Disable, and Delete

View the details of a plugin​

  1. Click the Name of the plugin you want to view. The detail screen has the following sections, all read-only:
SectionContent
General InformationSystem information: Plugin ID (with a copy icon), Created At, Created By, Updated At, Updated By.
Basic InformationDisplay Name, Description, and the Enabled status.
ScopeGlobal or Scoped. If Scoped, a table lists the assigned Routes / Services (and Consumers, for the Rate Limiting plugin). Click a name to open it.
ConfigurationThe configuration attributes and the matching JSON panel.

Plugin detail screen, Scope section

Click Update Plugin in the top-right corner to edit the plugin, see Edit a plugin.

note

A plugin attached to a Route / Service also appears on the Plugins tab of that Route / Service detail screen. See Plugin overview.

Next steps​

Last updated on