Operations on buckets

Edit online

Create a new bucket
A PUT issued to the endpoint root followed by a string will create a bucket using that string for a name.
Create a bucket replication configuration
Creates a replication configuration or replaces an existing one.
Schedule reattempt of failed replications in a bucket
Schedule reattempt of all failed replications in this bucket, including those that are no longer retried. As long-term failed replications are retried daily, this will schedule the stale failure reattempts for the cycle beginning at the next midnight (UTC+0).
List failed replications in a bucket
Returns a list of failed replications, limited to 1,000 at a time and returned in reverse chronological order (newest failure-first). The ordering is determined by when the replication was originally triggered, which corresponds to <FirstSyncAttempted> field in each failure entry. This listing will include any replication failures that have been failing for at least 4 hours since it was originally triggered.
Retrieve a bucket’s headers
A HEAD issued to a bucket resource will return the headers for that bucket. This operation does not make use of operation specific headers, query parameters, or payload elements.
Delete a bucket
A DELETE issued to an empty bucket resource deletes the bucket. After deleting a bucket the name is reserved by the system for 10 minutes then released for re-use. Only empty buckets can be deleted. This operation does not make use of operation specific headers, query parameters, or payload elements.
Delete a bucket replication configuration
Deletes the replication configuration from the bucket.
Retrieve a bucket replication configuration
Returns the replication configuration of a bucket.
List objects in a given bucket
A GET request addressed to a bucket returns a list of objects, limited to 1,000 at a time and returned in non-lexographical order. The StorageClass value that is returned in the response is the storage class set in the COS Manager in container mode, or the default value if no storage class is set or in vault mode.
List objects in a given bucket (v2)
A GET request addressed to a bucket with the query parameter list-type=2 returns a list of objects, limited to 1,000 at a time, returned in non-lexigraphical order and allows for additional flexibility in listing. The StorageClass value that is returned in the response is a default value as storage class operations are not implemented in the system. This operation does not make use of operation specific headers or payload elements.
Create an access control list for a bucket
A PUT issued to a bucket with the necessary query parameter creates or replaces an access control list (ACL) for that bucket. Access control lists allow for granting different sets of permissions to different storage accounts using the account’s ID, or by using a pre-made ACL.
Retrieve the access control list for a bucket
A GET issued to a bucket with the proper parameters retrieves the ACL for a bucket. This operation does not make use of operation specific headers, additional query parameters, or payload elements.
Create a cross-origin resource sharing configuration for a bucket
A PUT issued to a bucket with the proper parameters creates or replaces a cross-origin resource sharing (CORS) configuration for a bucket. An integrity check is required by using either content-md5, a x-amz-checksum- header, or the x-amz-content-sha256 header. This operation does not make use of operation specific headers or additional query parameters.
List any cross-origin resource sharing configuration for a bucket
A GET issued to a bucket with the proper parameters retrieves information about cross-origin resource sharing (CORS) configuration for a bucket. This operation does not make use of operation specific headers, additional query parameters, or payload elements.
Delete any cross-origin resource sharing configuration for a bucket
A DELETE issued to a bucket with the proper parameters removes cross-origin resource sharing (CORS) configuration for a bucket. This operation does not make use of operation specific headers, additional query parameters, or payload elements.
Set up a bucket for versioning
A PUT issued to a bucket with the proper parameters enables or suspends the versioning of objects stored in the bucket. Objects are limited to 1,000 versions: versioning limits, 1000 versions limit is vault mode only, container mode does not have a limit on how many versions you can have per object. Each object uploaded will automatically be assigned a unique version ID, which is shown in response headers as x-amz-version-id. In the event of multiple simultaneous object writes, all objects are stored as seperate versions. Any GET or HEAD request against an object resource can then be modified with the ?versionId= query parameter to specify a version. This operation does not make use of operation specific headers, additional query parameters, or payload elements.
Check if versioning is enabled on a bucket
A GET request addressed to a bucket with the proper parameter returns an indication of whether the bucket has versioning enabled, disabled, or never enabled. This operation does not make use of operation specific headers, additional query parameters, or payload elements.
List versioned objects in a bucket
A GET request addressed to a bucket returns a list of versioned objects, limited to 1,000 at a time and returned in non-lexographical order. The StorageClass value that is returned in the response is a default value as storage class operations are not implemented in COS. This operation does not make use of operation specific headers or payload elements.
Add protection to a bucket
This implementation of the PUT operation uses the protection subresource to set the retention parameters for an existing bucket. This operation allows you to set or change the minimum, default, and maximum retention period. It is not supported for protected mirrors.
Add Object Lock configuration on a bucket
IBM’s Object Lock storage feature allows users to store objects in a write once read many (WORM) fashion using rules and interfaces aligned with industry Object Lock implementations. This Object Lock storage feature is different from IBM’s Bucket Protection Feature (Also known as IBM Immutable Bucket Storage) and should be viewed as distinct from that feature.
Add tags to a bucket
A PUT issued to a bucket with the proper parameters adds tags to a bucket. This operation does not make use of operation specific headers or additional query parameters.
Delete tags from a bucket
A DELETE issued to a bucket with the proper parameters removes tags to a bucket. This operation does not make use of operation specific headers or additional query parameters.
List canceled/incomplete multipart uploads for a bucket
A GET issued to a bucket with the proper parameters retrieves information about any canceled or incomplete multipart uploads for a bucket.
List the protection configuration for a bucket
This implementation of the GET operation uses the protection subresource to return the protection configuration for the bucket.
Get Object Lock configuration on a bucket
Retrieve the configured Object Lock configuration on a bucket.
Create a bucket lifecycle configuration
A PUT operation uses the lifecycle query parameter to set lifecycle settings for the bucket. An integrity check is required by using either content-md5, a x-amz-checksum- header, or the x-amz-content-sha256 header.
Retrieve a bucket lifecycle configuration
A GET operation uses the lifecycle query parameter to retrieve lifecycle settings for the bucket.
Delete a bucket lifecycle configuration
A DELETE issued to a bucket with the proper parameters removes any lifecycle configurations for a bucket.
Create a bucket website configuration
A PUT operation uses the website query parameter to set the Website Configuration Policy for the bucket. An integrity check is optional for the payload. This can be done using Content-MD5, x-amz-content-sha256, or an x-amz-checksum- header.
Retrieve a bucket website configuration
A GET operation uses the website query parameter to retrieve website configuration settings for a bucket.
Delete a bucket website configuration
A DELETE issued to a bucket with the website query parameter will remove any website configuration policy from the bucket
Delete a public access block bucket
Removes the PublicAccessBlock configuration for a CSO S3 bucket.
Get public access block bucket
Retrieves the PublicAccessBlock configuration for a CSO S3 bucket.
Put public access block bucket
Creates or modifies the PublicAccessBlock configuration for an CSO S3 bucket.
Configuring a bucket policy for a vault
A bucket policy is a JSON-based Identity and Access Management configuration used to control user access to a vault.
Delete a bucket policy for vault
Removes the bucket policy configured on a vault.
Retrieve a bucket policy for vault
Retrieves a configured bucket policy for a vault. Only one bucket policy is configured per vault.

Parent topic: API reference