Method: integrationInstances.patch

Full name: projects.locations.instances.integrations.integrationInstances.patch

Updates an existing IntegrationInstance. Use this method to modify connection parameters (e.g., rotate an API key), change the display name, or update the description of a configured integration instance.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1beta/{integrationInstance.name}

Path parameters

Parameters
integrationInstance.name

string

Identifier. The unique name of the integration instance. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/integrationInstances/{instance}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to be updated.

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 IntegrationInstance.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.integrationInstances.update

For more information, see the IAM documentation.