Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Object Storage API, REST: Bucket.CreateInventoryConfiguration

Written by
Updated at December 1, 2025

Create/Update an inventory configuration with the corresponding ID

HTTP request

POST https://storage.api.cloud.yandex.net/storage/v1/buckets/{bucket}/{id}:createInventoryConfiguration

Path parameters

Field

Description

bucket

string

Required field. Name of the bucket to update the inventory configuration for.

id

string

Required field. ID of the inventory configuration to set.

Body parameters

{
  "configuration": {
    "id": "string",
    "destination": {
      "bucketDestination": {
        "bucket": "string",
        "format": "string",
        "prefix": "string"
      }
    },
    "includedObjectVersions": "string",
    "isEnabled": "boolean",
    "schedule": {
      "frequency": "string"
    },
    "filter": {
      "prefix": "string"
    },
    "optionalFields": [
      "string"
    ]
  }
}

Field

Description

configuration

InventoryConfiguration

Required field. Inventory configuration.

InventoryConfiguration

Field

Description

id

string

Required field. The ID used to identify the inventory configuration.

destination

InventoryDestination

Required field. Contains information about where to publish the inventory results.

includedObjectVersions

enum (IncludedObjectVersions)

Required field. Object versions to include in the inventory list.

  • ALL: Include all versions.
  • CURRENT: Include only the current version.

isEnabled

boolean

Specifies whether the inventory is enabled.

schedule

InventorySchedule

Required field. Specifies the schedule for generating inventory results.

filter

InventoryFilter

Specifies the filter for objects to include in the inventory.

optionalFields[]

enum (OptionalField)

Contains the optional fields that are included in the inventory results.

  • SIZE: The object size in bytes.
  • LAST_MODIFIED_DATE: The object creation date or the last modified date, whichever is the latest.
  • STORAGE_CLASS: The storage class that's used for storing the object.
  • ETAG: The entity tag (ETag) is a hash of the object.
  • IS_MULTIPART_UPLOADED: Specifies that the object was uploaded as a multipart upload.
  • ENCRYPTION_STATUS: The server-side encryption type that's used to encrypt the object.
  • OBJECT_LOCK_RETAIN_UNTIL_DATE: The date until which the object is locked.
  • OBJECT_LOCK_MODE: The level of protection applied to the object, either Governance or Compliance.
  • OBJECT_LOCK_LEGAL_HOLD_STATUS: The legal hold status of the locked object.
  • CHECKSUM_ALGORITHM: Indicates the algorithm that is used to create the checksum for the object.
  • OBJECT_ACCESS_CONTROL_LIST: An access control list (ACL) for each object.
  • OBJECT_OWNER: The owner of the object.

InventoryDestination

Field

Description

bucketDestination

InventoryBucketDestination

Required field. Destination bucket settings

InventoryBucketDestination

Field

Description

bucket

string

Required field. Bucket where inventory results will be published.

format

enum (Format)

Required field. Specifies the output format of the inventory results.

  • CSV: CSV format.

prefix

string

The prefix that is prepended to all inventory results.

InventorySchedule

Field

Description

frequency

enum (Frequency)

Required field. Specifies how frequently inventory results are produced.

  • DAILY: Daily generation.
  • WEEKLY: Weekly generation.

InventoryFilter

Field

Description

prefix

string

Required field. The prefix that an object must have to be included in the inventory results.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "name": "string"
  },
  // Includes only one of the fields `error`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateBucketInventoryConfigurationMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateBucketInventoryConfigurationMetadata

Field

Description

name

string

Bucket name for which inventory configuration will be set

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.
Previous
ListAccessBindings
Next
GetInventoryConfiguration
© 2025 Direct Cursus Technology L.L.C.