Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1351142229.7 KB
projects

Creates a Plugin instance in the API hub.

post/v1/{+parent}/instances

Path parameters

parentstring required

Required. The parent of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}

Query parameters

pluginInstanceIdstring

Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance'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 instance in the plugin resource. * If not provided, a system generated id will be used. This value should be 4-63 characters, and valid characters are /a-z[0-9]-_/.

Request body

updateTimestring google-datetime

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

createTimestring google-datetime

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

namestring

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

displayNamestring

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

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.

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.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'APPLYING_CONFIG' | 'ERROR' | 'FAILED' | 'DELETING'

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

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.

Response

Successful response