Method: folders.locations.auditSchedules.patch

Updates an existing audit schedule.

HTTP request

PATCH https://auditmanager.googleapis.com/v1/{auditSchedule.name=folders/*/locations/*/auditSchedules/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
auditSchedule.name

string

Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{auditSchedule} folders/{folder}/locations/{location}/auditSchedules/{auditSchedule} organizations/{organization}/locations/{location}/auditSchedules/{auditSchedule}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. List of fields to update.

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

boolean

Optional. If true, only validates the request and does not update the audit schedule. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes: * Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs. * User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests. * CI/CD & Automation: Test your scripts, permissions, and parameters safely without consuming resource quotas.

Request body

The request body contains an instance of AuditSchedule.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • auditmanager.auditSchedules.update

For more information, see the IAM documentation.