Using the Object Storage API

Jump toUpdate content

Object Storage API

Reviewed on 19 July 2023 • Published on 13 September 2018

In this page we index all available Scaleway Object Storage API requests.

Security & Identity (IAM):

You may need certain IAM permissions to carry out some actions described on this page. This means:

you are the Owner of the Scaleway Organization in which the actions will be carried out, or
you are an IAM user of the Organization, with a policy granting you the necessary permission sets

Note:

When you use Object Storage directly with the API, you must generate an Authentication Signature v4 beforehand.

Status:

Feature available: ✅
Feature coming in 2023: ⌛
Deprecated feature: ❗

Common Operations

Feature	Description	Status
GetService	Returns a list of all buckets	✅

Bucket Operations

Feature	Description	Status
CreateBucket	Creates bucket	✅
DeleteBucket	Deletes bucket	✅
DeleteBucketCors	Deletes the CORS configuration of a bucket	✅
DeleteBucketLifecycle	Deletes the lifecycle configuration of a bucket	✅
DeleteBucketPolicy	Deletes the policy of a specified bucket	✅
DeleteBucketTagging	Deletes the tag(s) of a bucket	✅
DeleteBucketWebsite	Deletes the bucket website configuration of a specified bucket	✅
GetBucketAcl	Returns the bucket ACL	✅
GetBucketCors	Returns the CORS configuration of a bucket	✅
GetBucketLifecycle	Returns the lifecycle configuration information set on the bucket	❗
GetBucketLifecycleConfiguration	Returns the lifecycle configuration information set on a bucket	✅
GetBucketLocation	Returns the region where the bucket is	✅
GetBucketNotification	Returns the notification configuration of a bucket	⌛
GetBucketPolicy	Returns the policy of a specified bucket	✅
GetBucketPolicyStatus	Retrieves the policy status for a bucket. The status indicates whether a bucket is public or not	✅
GetBucketTagging	Returns the tag(s) of a bucket	✅
GetBucketVersioning	Returns the versioning state of a bucket	✅
GetBucketWebsite	Returns the bucket website basic configuration	✅
HeadBucket	Checks if the bucket exists	✅
ListObjects	Lists objects in the bucket	✅
ListObjectsV2	Returns some or all (up to 1,000) of the objects in a bucket	✅
ListObjectVersions	Returns metadata about all the versions of objects in a bucket	✅
PutBucketAcl	Configures the Access Control List of a bucket	✅
PutBucketCors	Configures CORS on a bucket	✅
PutBucketLifecycle	Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration	❗
PutBucketLifecycleConfiguration	Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration	✅
PutBucketNotification	Enables notifications of specified events for a bucket	⌛
PutBucketPolicy	Applies an S3 bucket policy to an S3 bucket. The key elements of bucket policy are Version, ID, Statement, Sid, Principal, Action, Effect, Resource and Condition. You can find out more about each element by clicking the links, or consulting the full documentation	✅
PutBucketTagging	Sets the tag(s) of a bucket	✅
PutBucketVersioning	Sets the versioning state of an existing bucket	✅
PutBucketWebsite	Enables bucket website and sets the basic configuration for the website	✅

Object Operations

Feature	Description	Status
AbortMultipartUpload	Aborts a multipart upload	✅
CompleteMultipartUpload	Assembles previously uploaded parts to completes a multipart upload	✅
CopyObject	Copies an object	✅
CreateMultipart	Initiates a multipart upload and returns the upload ID	✅
DeleteObjects	Delete multiple objects in a single request (up to 1000)	✅
DeleteObject	Deletes an object	✅
DeleteObjectTagging	Deletes the tag(s) of an object	✅
GetObject	Retrieves an object	✅
GetObjectAcl	Gets the ACL of an object	✅
GetObjectLegalHold	Gets an object’s current Legal Hold configuration	✅
GetObjectLockConfiguration	Gets an object Lock configuration for a bucket. The specified rule will be applied by default to every new object placed in the bucket	✅
GetObjectRetention	Retrieves an object’s retention settings	✅
GetObjectTagging	Get the tag(s) of an object	✅
HeadObject	Gets object metadata	✅
ListMultipart	Lists in-progress multipart uploads	✅
OPTIONS object	Allows to send a preflight request to trigger an evaluation of the rules that are defined in the CORS configuration	✅
POST object	Adds an object to a bucket by using HTML forms	✅
PutObject	Adds an object to a bucket	✅
PutObjectAcl	Adds an ACL to an object	✅
PutObjectTagging	Adds one or several tags to an object	✅
PutObjectLegalHold	Applies a Legal Hold configuration to the specified object	✅
PutObjectLockConfiguration	Sets an object lock configuration on a specified bucket	✅
PutObjectRetention	Places an object Retention configuration on an object	✅
RestoreObject	Restores an object from `Glacier`	✅
UploadPart	Uploads a part in a multipart upload	✅
UploadPartCopy	Copies data from an existing object as data source to upload a part	✅