projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/plugins/{pluginsId}/instances/{instancesId}

Changed on Nov 8, 2026

Updates a plugin instance in the API hub. The following fields in the plugin_instance can be updated currently: * display_name * schedule_cron_expression The update_mask should be used to specify the fields being updated. To update the auth_config and additional_config of the plugin instance, use the ApplyPluginInstanceConfig method.

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/:pluginsId/instances/:instancesId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required

locationsIdstring required

pluginsIdstring required

instancesIdstring required

Query parameters

updateMaskstring google-fieldmask

Optional. The list of fields to update.

Request body

additionalConfigobject

Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable.

createTimestring google-datetime

Output only. Timestamp indicating when the plugin instance was created.

displayNamestring

Required. The display name for this plugin instance. Max length is 500 characters.

errorMessagestring

Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state.

namestring

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

sourceEnvironmentsConfigobject

Optional. The source environment's config present in the gateway instance linked to the plugin instance. The key is the source_environment name from the SourceEnvironment message.

sourceProjectIdstring

Optional. The source project id of the plugin instance. This will be the id of runtime project in case of Google Cloud based plugins and org id in case of non-Google Cloud based plugins. This field will be a required field for Google provided on-ramp plugins.

Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).

updateTimestring google-datetime

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

Response

Successful response