buckets

Overview

Name	buckets
Type	Resource
Id	linode.object_storage.buckets

Fields

Name	Datatype	Description
cluster	string	The ID of the Object Storage Cluster this bucket is in.
created	string	When this bucket was created.
hostname	string	The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.
label	string	The name of this bucket.
objects	integer	The number of objects stored in this bucket.
size	integer	The size of the bucket in bytes.

Methods

Name	Accessible by	Required Params	Description
getObjectStorageBucket	SELECT	bucket, clusterId	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.
getObjectStorageBucketinCluster	SELECT	clusterId	Returns a list of Buckets in this cluster belonging to this Account. This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.
getObjectStorageBuckets	SELECT		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.
createObjectStorageBucket	INSERT	data__cluster, data__label	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.
deleteObjectStorageBucket	DELETE	bucket, clusterId	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.
_getObjectStorageBucket	EXEC	bucket, clusterId	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.
_getObjectStorageBucketinCluster	EXEC	clusterId	Returns a list of Buckets in this cluster belonging to this Account. This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.
_getObjectStorageBuckets	EXEC		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.
_viewObjectStorageBucketACL	EXEC	bucket, clusterId	View an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users. This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.
modifyObjectStorageBucketAccess	EXEC	bucket, clusterId	Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs. For more fine-grained control of both systems, please use the more fully-featured S3 API directly.
updateObjectStorageBucketACL	EXEC	bucket, clusterId, data__acl, data__name	Update an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users. This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.
updateObjectStorageBucketAccess	EXEC	bucket, clusterId	Allows changing basic Cross-origin Resource Sharing (CORS) and Access Control Level (ACL) settings. Only allows enabling/disabling CORS for all origins, and/or setting canned ACLs. For more fine-grained control of both systems, please use the more fully-featured S3 API directly.
viewObjectStorageBucketACL	EXEC	bucket, clusterId	View an Object's configured Access Control List (ACL) in this Object Storage bucket. ACLs define who can access your buckets and objects and specify the level of access granted to those users. This endpoint is available for convenience. It is recommended that instead you use the more fully-featured S3 API directly.