Contact UsGet started
© 2024 Iron Hive LLC Belgrade
Yandex Object Storage

Object Storage API, REST: Bucket.create

Written by
Updated at May 26, 2023

Creates a bucket in the specified folder.

HTTP request

POST https://storage.api.cloud.yandex.net/storage/v1/buckets

Body parameters

{
  "name": "string",
  "folderId": "string",
  "defaultStorageClass": "string",
  "maxSize": "string",
  "anonymousAccessFlags": {
    "read": true,
    "list": true,
    "configRead": true
  },
  "acl": {
    "grants": [
      {
        "permission": "string",
        "grantType": "string",
        "granteeId": "string"
      }
    ]
  },
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Field Description
name string

Required. Name of the bucket.

The name must be unique within the platform. For naming limitations and rules, see documentation.
folderId string

Required. ID of the folder to create a bucket in.

To get the folder ID, make a list request.

The maximum string length in characters is 50.
defaultStorageClass string

Default storage class for objects in the bucket. Supported classes are standard storage (STANDARD), cold storage (COLD, STANDARD_IA, NEARLINE all synonyms), and ice storage (ICE and GLACIER are synonyms). For details, see documentation.
maxSize string (int64)

Maximum size of the bucket. For details, see documentation.
anonymousAccessFlags object

Flags for configuring public (anonymous) access to the bucket's content and settings. For details, see documentation.
anonymousAccessFlags.
read		 boolean (boolean)

Specifies whether public (anonymous) access to read objects in the bucket is enabled.
anonymousAccessFlags.
list		 boolean (boolean)

Specifies whether public (anonymous) access to the list of objects in the bucket is enabled.
anonymousAccessFlags.
configRead		 boolean (boolean)

Specifies whether public (anonymous) access to read CORS, static website hosting, and object lifecycles settings of the bucket is enabled.
acl object

Access control list (ACL) of the bucket. For details, see documentation.
acl.
grants[]		 object

List of permissions granted and the grantees.
acl.
grants[].
permission		 string

Required. Permission granted by the grant.

  • PERMISSION_FULL_CONTROL: Allows grantee the PERMISSION_WRITE, PERMISSION_WRITE_ACP, PERMISSION_READ, and PERMISSION_READ_ACP on the bucket.

    Maps to x-amz-grant-full-control header for bucketPutAcl method of Amazon S3-compatible HTTP API.

  • PERMISSION_WRITE: Allows grantee to create new objects in the bucket. For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

    Maps to x-amz-grant-write header for bucketPutAcl method of Amazon S3-compatible HTTP API.

  • PERMISSION_WRITE_ACP: Allows grantee to write the ACL for the bucket.

    Maps to x-amz-grant-write-acp header for bucketPutAcl method of Amazon S3-compatible HTTP API.

  • PERMISSION_READ: Allows grantee to list the objects in the bucket.

    Maps to x-amz-grant-read header for bucketPutAcl method of Amazon S3-compatible HTTP API.

  • PERMISSION_READ_ACP: Allows grantee to read the bucket ACL

    Maps to x-amz-grant-read-acp header for bucketPutAcl method of Amazon S3-compatible HTTP API.
acl.
grants[].
grantType		 string

Required. The grantee type for the grant.

  • GRANT_TYPE_ACCOUNT: A grantee is an account on the platform.

    For this grantee type, you need to specify the user ID in Bucket.acl.grants.granteeId field. To get user ID, see instruction.

    Maps to using id="*" value for x-amz-grant-* header (bucketPutAcl method of Amazon S3-compatible HTTP API).

  • GRANT_TYPE_ALL_AUTHENTICATED_USERS: Grantees are all authenticated users, both from your clouds and other users' clouds. Access permission to this group allows any account on the platform to access the resource via a signed (authenticated) request.

    Maps to using uri="http://acs.amazonaws.com/groups/global/AuthenticatedUsers" value for x-amz-grant-* header (bucketPutAcl method of Amazon S3-compatible HTTP API).

  • GRANT_TYPE_ALL_USERS: Grantees are all internet users. Access permission to this group allows anyone in the world access to the resource via signed (authenticated) or unsigned (anonymous) requests.

    Maps to using uri="http://acs.amazonaws.com/groups/global/AllUsers" value for x-amz-grant-* header (bucketPutAcl method of Amazon S3-compatible HTTP API).
acl.
grants[].
granteeId		 string

ID of the account who is a grantee. Required when the grantType is GRANT_TYPE_ACCOUNT.
tags[] object

List of tags for the bucket. For details, see documentation.
tags[].
key		 string

Key of the bucket tag.
tags[].
value		 string

Value of the bucket tag.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "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 (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 object

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 object
The error result of the operation in case of failure or cancellation.
includes only one of the fields error, response
error.
code		 integer (int32)

Error code. An enum value of google.rpc.Code.
error.
message		 string

An error message.
error.
details[]		 object

A list of messages that carry the error details.
response object
includes only one of the fields error, response

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.
Previous
Overview
Next
delete
© 2024 Iron Hive LLC Belgrade
In this article: