Method: projects.locations.connections.patch

Updates a single connection.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
connection.name

string

Immutable. The resource name of the connection, in the format projects/{project}/locations/{location}/connections/{connectionId}.

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated.

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

allowMissing

boolean

If set to true, and the connection is not found a new connection will be created. In this situation updateMask is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a githubConfig with both user_oauth_token and installationId properties).

etag

string

The current etag of the connection. If an etag is provided and does not match the current etag of the connection, update will be blocked and an ABORTED error will be returned.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • cloudbuild.connections.update

For more information, see the IAM documentation.