Object Storage
Object Storage Bucket View
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}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.
Path Parameters
The ID of the cluster this bucket exists in.
The bucket name.
Request Samples
- Shell
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket
Response Samples
- 200
- default
{
"created": "2019-01-01T01:23:45.000Z",
"label": "example-bucket",
"size": 188318981,
"hostname": "example-bucket.us-east-1.linodeobjects.com",
"cluster": "us-east-1",
"objects": 4
}Responses
200: The requested bucket.
When this bucket was created.
The name of this bucket.
The size of the bucket in bytes.
The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.
The ID of the Object Storage Cluster this bucket is in.
The number of objects stored in this bucket.
default: Error
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.
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.
Object Storage Bucket Remove
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}Removes a single bucket.
Bucket objects must be removed prior to removing the bucket. While buckets containing objects may be deleted using the s3cmd command-line tool, such operations can 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.
Path Parameters
The ID of the cluster this bucket exists in.
The bucket name.
Request Samples
- Shell
curl -H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket
Response Samples
- 200
- default
{}Responses
200: Bucket deleted successfully.
default: Error
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.
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.