2026-09-16
▼ ▲ auditmanager.folders.locations.auditSchedules.create
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditSchedules
Parameter Order : parent
Description : Creates a new audit schedule in a given project and location.
Parameters :
validateOnly
Description : Optional. If `true`, only validates the request and does not create 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.
Location : query
Type : boolean
parent
Type : string
Required : Yes
Pattern : ^folders/[^/]+/locations/[^/]+$
Description : Required. Project or folder that this audit schedule is for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}`
Location : path
auditScheduleId
Type : string
Description : Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.
Location : query
Scopes :
HTTP Method : POST
Path : v1/{+parent}/auditSchedules
▼ ▲ auditmanager.folders.locations.auditSchedules.get
Path : v1/{+name}
Description : Gets details of a single audit schedule.
Scopes :
Parameters :
name
Type : string
Required : Yes
Description : Required. Name of the audit schedule to retrieve, in one of the following formats: * `projects/{project}/locations/{location}/auditSchedules/{audit_schedule}` * `folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}` * `organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}`
Location : path
Pattern : ^folders/[^/]+/locations/[^/]+/auditSchedules/[^/]+$
HTTP Method : GET
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditSchedules/{auditSchedulesId}
Parameter Order : name
▼ ▲ auditmanager.folders.locations.auditSchedules.patch
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditSchedules/{auditSchedulesId}
Description : Updates an existing audit schedule.
Scopes :
Parameter Order : name
HTTP Method : PATCH
Parameters :
name
Required : Yes
Description : Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{audit_schedule} folders/{folder}/locations/{location}/auditSchedules/{audit_schedule} organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}
Pattern : ^folders/[^/]+/locations/[^/]+/auditSchedules/[^/]+$
Location : path
Type : string
validateOnly
Description : 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.
Type : boolean
Location : query
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Optional. List of fields to update.
Path : v1/{+name}
▼ ▲ auditmanager.folders.locations.auditSchedules.list
Description : Lists audit schedules in a given project and location.
Path : v1/{+parent}/auditSchedules
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
parent
Type : string
Description : Required. Parent for the audit schedule, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Pattern : ^folders/[^/]+/locations/[^/]+$
Location : path
Required : Yes
pageSize
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Location : query
Type : integer
Format : int32
Scopes :
Parameter Order : parent
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditSchedules
HTTP Method : GET
▼ ▲ auditmanager.organizations.locations.auditSchedules.patch
Parameter Order : name
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditSchedules/{auditSchedulesId}
Path : v1/{+name}
HTTP Method : PATCH
Parameters :
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. List of fields to update.
validateOnly
Location : query
Description : 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.
Type : boolean
name
Description : Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{audit_schedule} folders/{folder}/locations/{location}/auditSchedules/{audit_schedule} organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}
Location : path
Type : string
Pattern : ^organizations/[^/]+/locations/[^/]+/auditSchedules/[^/]+$
Required : Yes
Scopes :
Description : Updates an existing audit schedule.
▼ ▲ auditmanager.organizations.locations.auditSchedules.get
Scopes :
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Description : Required. Name of the audit schedule to retrieve, in one of the following formats: * `projects/{project}/locations/{location}/auditSchedules/{audit_schedule}` * `folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}` * `organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}`
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+/auditSchedules/[^/]+$
Path : v1/{+name}
Description : Gets details of a single audit schedule.
HTTP Method : GET
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditSchedules/{auditSchedulesId}
▼ ▲ auditmanager.organizations.locations.auditSchedules.list
HTTP Method : GET
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditSchedules
Path : v1/{+parent}/auditSchedules
Description : Lists audit schedules in a given project and location.
Scopes :
Parameters :
pageToken
Location : query
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
parent
Type : string
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+$
Description : Required. Parent for the audit schedule, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Location : path
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Parameter Order : parent
▼ ▲ auditmanager.organizations.locations.auditSchedules.create
Path : v1/{+parent}/auditSchedules
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditSchedules
Scopes :
HTTP Method : POST
Parameters :
parent
Type : string
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+$
Description : Required. Project or folder that this audit schedule is for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}`
Location : path
validateOnly
Description : Optional. If `true`, only validates the request and does not create 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.
Type : boolean
Location : query
auditScheduleId
Location : query
Description : Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.
Type : string
Parameter Order : parent
Description : Creates a new audit schedule in a given project and location.
▼ ▲ auditmanager.projects.locations.auditSchedules.create
Path : v1/{+parent}/auditSchedules
HTTP Method : POST
Scopes :
Parameter Order : parent
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. Project or folder that this audit schedule is for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}`
validateOnly
Location : query
Description : Optional. If `true`, only validates the request and does not create 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.
Type : boolean
auditScheduleId
Type : string
Description : Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.
Location : query
Description : Creates a new audit schedule in a given project and location.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditSchedules
▼ ▲ auditmanager.projects.locations.auditSchedules.patch
Description : Updates an existing audit schedule.
Parameter Order : name
HTTP Method : PATCH
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/auditSchedules/[^/]+$
Type : string
Required : Yes
Description : Identifier. Unique identifier for the audit schedule. Format: projects/{project}/locations/{location}/auditSchedules/{audit_schedule} folders/{folder}/locations/{location}/auditSchedules/{audit_schedule} organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}
Location : path
validateOnly
Location : query
Description : 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.
Type : boolean
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. List of fields to update.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditSchedules/{auditSchedulesId}
Scopes :
▼ ▲ auditmanager.projects.locations.auditSchedules.list
Scopes :
HTTP Method : GET
Path : v1/{+parent}/auditSchedules
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditSchedules
Parameters :
pageToken
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
Location : query
parent
Description : Required. Parent for the audit schedule, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Description : Lists audit schedules in a given project and location.
▼ ▲ auditmanager.projects.locations.auditSchedules.get
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/auditSchedules/[^/]+$
Location : path
Description : Required. Name of the audit schedule to retrieve, in one of the following formats: * `projects/{project}/locations/{location}/auditSchedules/{audit_schedule}` * `folders/{folder}/locations/{location}/auditSchedules/{audit_schedule}` * `organizations/{organization}/locations/{location}/auditSchedules/{audit_schedule}`
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditSchedules/{auditSchedulesId}
Path : v1/{+name}
Parameter Order : name
HTTP Method : GET
Description : Gets details of a single audit schedule.
Scopes :