- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
List all the plugins in a given project and location.
HTTP request
GET https://apihub.googleapis.com/v1/{parent=projects/*/locations/*}/plugins
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent
|
Required. The parent resource where this plugin will be created. Format: |
Query parameters
filter
string
Optional. An expression that filters the list of plugins.
A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: <
, >
or =
. Filters are not case sensitive.
The following fields in the Plugins
are eligible for filtering:
-
pluginCategory- The category of the Plugin. Allowed comparison operators:=.
Expressions are combined with either AND
logic operator or OR
logical operator but not both of them together i.e. only one of the AND
or OR
operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT
error is returned by the API. Here are a few examples:
-
pluginCategory = ON_RAMP- The plugin is of category on ramp.
pageSize
integer
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
Optional. A page token, received from a previous plugins.list
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters (except pageSize) provided to plugins.list
must match the call that provided the page token.
Request body
The request body must be empty.
Response body
The plugins.list
method's response.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"plugins"
:
[
{
object (
|
| Fields | |
|---|---|
plugins[]
|
The plugins from the specified parent resource. |
nextPageToken
|
A token, which can be sent as |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
IAM Permissions
Requires the following IAM
permission on the parent
resource:
-
apihub.plugins.list
For more information, see the IAM documentation .
