Sign in
organizations

Creates a new audit schedule in a given project and location.

post/v1/{+parent}/auditSchedules

Request

  • Base URL: https://auditmanager.googleapis.com
  • URL: https://auditmanager.googleapis.com/v1/{+parent}/auditSchedules
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-auditmanager) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-auditmanager)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

parentstring required

Required. Project or folder that this audit schedule is for, in one of the following formats: * projects/{project}/locations/{location} * folders/{folder}/locations/{location}

Query parameters

auditScheduleIdstring

Required. ID to use for the audit schedule, which becomes the final component of the audit schedule's resource name.

validateOnlyboolean

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.

Request body

lastTriggerTimestring google-datetime

Output only. Timestamp when the audit run was last triggered.

updateTimestring google-datetime

Output only. Timestamp when the schedule was last updated.

state'SCHEDULE_STATE_UNSPECIFIED' | 'SCHEDULE_STATE_ACTIVE' | 'SCHEDULE_STATE_PAUSED' | 'SCHEDULE_STATE_COMPLETED' | 'SCHEDULE_STATE_FAILED_SETUP' | 'SCHEDULE_STATE_ERROR' | 'SCHEDULE_STATE_DELETED'

Optional. State of the audit schedule. While most states are managed by the system, you can use UpdateAuditSchedule to start, pause, or delete the schedule.

namestring

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}

complianceFrameworkstring

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

displayNamestring

Optional. Display name for the audit schedule.

createTimestring google-datetime

Output only. Timestamp when the schedule was created.

nextRunTimestring google-datetime

Output only. Calculated timestamp for the next scheduled run.

reportFormat'AUDIT_REPORT_FORMAT_UNSPECIFIED' | 'AUDIT_REPORT_FORMAT_ODF'

Required. Format for the audit report.

gcsUristring

Required. Cloud Storage bucket where Audit Manager can upload the audit report and evidence. The format is gs://{bucket_name}.

errorMessagestring

Output only. Describes the error if the schedule is in an error state.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.