ReportConfig: insert

Creates a new inventory report configuration.

For general information about inventory reports in Cloud Storage, see the Storage Insights inventory reports documentation.

Required permissions

The authenticated user must have the storageinsights.reportConfigs.create IAM permission to use this method.


HTTP request


In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.


Path parameter Value Description
project string A valid API project identifier.
location string The location of the ReportConfig. The source and destination buckets specified in the ReportConfig must be in the same location.

Request body

In the request body, supply a ReportConfig resource with the following properties:

Property name Value Description Notes
Required properties
frequency_options object Options for configuring how inventory reports are generated. Writable
frequency_options.frequency enum The frequency in which inventory reports are generated. Values are DAILY or WEEKLY. Writable
frequency_options.start_date object The date to start generating inventory reports. For example, {"day": 15, "month": 8, "year": 2022}. Writable
frequency_options.end_date object The date to stop generating inventory reports. For example, {"day": 15, "month": 9, "year": 2022}. Writable
object_metadata_report_options object Options for including metadata in an inventory report. Writable
object_metadata_report_options.metadata_fields list The metadata included in an inventory report. Writable
object_metadata_report_options.storage_filters.bucket string The filter to use when specifying which bucket to generate inventory reports for. Writable
object_metadata_report_options.storage_destination_options object Options for where the inventory reports are stored. Writable
object_metadata_report_options.storage_destination_options.bucket string The destination bucket that stores the generated inventory reports. Writable
Optional properties
csv_options object Specifies that inventory reports will be generated in the comma-separated values (CSV) file format. If specified, parquet_options cannot be specified. Writable
parquet_options object Specifies that inventory reports will be generated in the Apache Parquet file format. If specified, csv_options cannot be specified. Writable


If successful, this method returns a ReportConfig in the response body.