Object Storage
Object Storage Buckets List
https://api.linode.com/v4/object-storage/buckets
Returns a paginated list of all Object Storage Buckets that you own.
This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.
Request Samples
- Shell
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/object-storage/buckets/
Response Samples
- 200
- default
{
"data": [
{
"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
}
],
"page": 1,
"pages": 1,
"results": 1
}Responses
200: A paginated list of buckets you own.
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.
The current page.
The total number of pages.
The total number of results.
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 Create
https://api.linode.com/v4/object-storage/buckets
Creates an Object Storage Bucket in the specified cluster.
Accounts with negative balances cannot access this command.
If the bucket already exists and is owned by you, this endpoint returns a 200 response with that bucket as if it had just been created.
This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.
Request Body Schema
The ID of the Object Storage Cluster where this bucket should be created.
The name for this bucket. Must be unique in the cluster you are creating the bucket in, or an error will be returned. Labels will be reserved only for the cluster that active buckets are created and stored in. If you want to reserve this bucket's label in another cluster, you must create a new bucket with the same label in the new cluster.
The Access Control Level of the bucket using a canned ACL string. For more fine-grained control of ACLs, use the S3 API directly.
If true, the bucket will be created with CORS enabled for all origins. For more fine-grained controls of CORS, use the S3 API directly.
Request Samples
- Shell
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X POST -d '{
"label": "example-bucket",
"cluster": "us-east-1",
"cors_enabled": true,
"acl": "private"
}' \
https://api.linode.com/v4/object-storage/buckets/
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 bucket created successfully.
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.