API

Create an Object Storage bucket

post
https://api.linode.com//object-storage/buckets

Creates an Object Storage bucket in the specified data center (region). If the bucket already exists on your account, this operation returns a 200 response with that bucket as if the API just created it.

📘

  • Accounts with negative balances can't access this operation.

  • The API still supports the clusterId equivalent (us-west-1) when setting a region for a new bucket, but you should use the regionId (us-west) instead.

  • This operation has specific rate limits.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: object_storage:read_write
Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
Body Params
string
enum
Defaults to private

The S3 predefined collection of grantees and permissions set for the bucket, also referred to as a Canned ACL.

Allowed:
boolean

If set to false, cross-origin resource sharing (CORS) is disabled for all origins in the bucket.

string
enum

The type of s3_endpoint available to the active user in this region. See Endpoint types for more information.

Allowed:
string
required

The name for this bucket.

  • A bucket name can contain from 3 to 63 alphanumeric characters, dashes (-), or dots (.).
  • A bucket name can't end in a dash and you can't use two consecutive dashes.
  • A bucket name can't start or end in a dot, and you can't use two consecutive dots. As a best practice, only use dots if a certificate you're using with your bucket requires it. (For example, if you're using a custom TLS certificate.)
  • A bucket name needs to be unique in the region where you're creating the bucket. The API only reserves labels for the region where active buckets are created and stored. If you want to reserve this bucket's label in another region, create a new bucket with the same label in the new region.
string
required

The id assigned to the data center (region) where this Object Storage bucket should be created.

📘

This supports legacy clusterId values that represented a specific region. For example, us-east-1 is the legacy reference for the us-east region.

string

The active user's S3-compatible endpoint URL, based on the endpoint_type and region.

Responses

Updated 28 days ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated 28 days ago