Method: jobInstances.patch

Full name: projects.locations.instances.integrations.jobs.jobInstances.patch

Updates an existing IntegrationJobInstance. Use this method to modify the execution interval, enable/disable the job instance, or adjust the parameters passed to the background script.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{integrationJobInstance.name}

Path parameters

Parameters
integrationJobInstance.name

string

Identifier. The unique name(ID) of the job instance. Format: projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/jobs/{job}/jobInstances/{jobInstance}"

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update.

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

Response body

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

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.jobInstances.update

For more information, see the IAM documentation.