Method: projects.locations.connections.patch

Updates the parameters of a single Connection.

HTTP request

PATCH https://connectors.googleapis.com/v1/{connection.name=projects/*/locations/*/connections/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
connection.name

string

Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. You can modify only the fields listed below.

To lock/unlock a connection: * lockConfig

To suspend/resume a connection: * suspended

To update the connection details: * description * labels * connectorVersion * configVariables * authConfig * destinationConfigs * nodeConfig * logConfig * sslConfig * eventingEnablementType * eventingConfig * authOverrideEnabled

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Connection.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.