projects

POST /v1/projects/{projectsId}/locations/{locationsId}/plugins

Changed on Nov 8, 2026

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

Request

Base URL
https://apihub.googleapis.com
Auth
- OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/apihub.readwrite
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/apihub.readwrite
- or OAuth 2 and OAuth 2
  Implicithttps://accounts.google.com/o/oauth2/auth
  Scopeshttps://www.googleapis.com/auth/cloud-platform
  Authorization codehttps://accounts.google.com/o/oauth2/auth
  Token URLhttps://accounts.google.com/o/oauth2/token
  Scopeshttps://www.googleapis.com/auth/cloud-platform
TypeScript
https://skmtc.dev/google/apis/apihub/docs/v1/projects/:projectsId/locations/:locationsId/plugins/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required

locationsIdstring required

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

createTimestring google-datetime

Output only. Timestamp indicating when the plugin was created.

descriptionstring

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

displayNamestring

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

Optional. The type of the gateway.

namestring

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

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

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

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.

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.

updateTimestring google-datetime

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

Response

Successful response