Object Storage

View Object Storage Bucket

get
https://api.linode.com/v4beta/object-storage/buckets/{clusterId}/{bucket}
BETA

Returns a single Object Storage Bucket.

This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_only)

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  https://api.linode.com/v4beta/object-storage/buckets/us-east-1/example-bucket

Response Samples

{
  "created": "2019-01-01T01:23:45.000Z",
  "label": "example-bucket",
  "size": 123,
  "region": "us-east",
  "hostname": "example-bucket.us-east-1.linodeobjects.com",
  "cluster": "us-east-1",
  "objects": 4
}

Responses

200: The requested bucket.

created
string <date-time>

When this bucket was created.

label
string

The name of this bucket.

size
integer

The size of this bucket, in bytes.

region
string

The ID of the Region this bucket exists in.

hostname
string

The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.

cluster
string

The ID of the Object Storage Cluster this bucket is in.

objects
integer

The number of objects in this bucket.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Remove Object Storage Bucket

delete
https://api.linode.com/v4beta/object-storage/buckets/{clusterId}/{bucket}
BETA

Removes a single bucket. While buckets containing objects may be deleted by including the force option in the request, such operations will fail if the bucket contains too many objects. The recommended way to empty large buckets is to use the S3 API to configure lifecycle policies that remove all objects, then delete the bucket.

This endpoint is available for convenience. It is recommended that instead you use the more fully- featured S3 API directly.

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receive breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_write)

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  -X DELETE \
  https://api.linode.com/v4beta/object-storage/buckets/us-east-1/example-bucket

Response Samples

{}

Responses

200: Bucket deleted successfully.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.