Post v1+parentplugins — apihub

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1351142229.7 KB

projects

Create an API Hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.

post/v1/{+parent}/plugins

Path parameters

parentstring required

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location}.

Query parameters

pluginIdstring

Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance. * If not provided, a system generated id will be used. This value should be 4-63 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin}, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.

Request body

state'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED'

Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level.

createTimestring google-datetime

Output only. Timestamp indicating when the plugin was created.

updateTimestring google-datetime

Output only. Timestamp indicating when the plugin was last updated.

ownershipType'OWNERSHIP_TYPE_UNSPECIFIED' | 'SYSTEM_OWNED' | 'USER_OWNED'

Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.

descriptionstring

Optional. The plugin description. Max length is 2000 characters (Unicode code points).

namestring

Identifier. The name of the plugin. Format: projects/{project}/locations/{location}/plugins/{plugin}

displayNamestring

Required. The display name of the plugin. Max length is 50 characters (Unicode code points).

pluginCategory'PLUGIN_CATEGORY_UNSPECIFIED' | 'API_GATEWAY' | 'API_PRODUCER'

Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.

Optional. The type of the gateway.

Response

Successful response