HomeStorageObject StorageAPI/CLI
Using the Object Storage API

Jump toUpdate content

Using the Scaleway Object Storage API

Reviewed on 01 April 2022Published on 13 September 2018

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

Note:

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

Status:

  • Feature available: «Validate Icon»
  • Feature coming in 2022: ⌛

Common Operations

FeatureDescriptionStatus
GetServiceReturns a list of all buckets«Validate Icon»

Bucket Operations

FeatureDescriptionStatus
DeleteBucketDeletes bucket«Validate Icon»
DeleteBucketCorsDeletes the CORS configuration of a bucket«Validate Icon»
DeleteBucketLifecycleDeletes the lifecycle configuration of a bucket«Validate Icon»
DeleteBucketPolicyDeletes the policy of a specified bucket«Validate Icon»
DeleteBucketTaggingDeletes the tag(s) of a bucket«Validate Icon»
DeleteBucketWebsiteDeletes the bucket website configuration of a specified bucket«Validate Icon»
GetBucketLists objects«Validate Icon»
GetBucketAclReturns the bucket ACL«Validate Icon»
GetBucketCorsReturns the CORS configuration of a bucket«Validate Icon»
GetBucketLifecycleReturns the lifecycle configuration of a bucket«Validate Icon»
GetBucketLocationReturns the region where the bucket is«Validate Icon»
GetBucketNotificationReturns the notification configuration of a bucket
GetBucketPolicyReturns the policy of a specified bucket«Validate Icon»
GetBucketTaggingReturns the tag(s) of a bucket«Validate Icon»
GetBucketVersioningReturns the versioning state of a bucket«Validate Icon»
GetBucketWebsiteReturns the bucket website basic configuration«Validate Icon»
HeadBucketChecks if the bucket exists«Validate Icon»
ListObjectVersionsReturns metadata about all of the versions of objects in a bucket«Validate Icon»
PutBucketCreates bucket«Validate Icon»
PutBucketAclConfigures the Access Control List of a bucket«Validate Icon»
PutBucketCorsConfigures CORS on a bucket«Validate Icon»
PutBucketLifecycleSets the lifecycle configuration of a bucket«Validate Icon»
PutBucketNotificationEnables notifications of specified events for a bucket
PutBucketPolicyApplies 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«Validate Icon»
PutBucketTaggingSets the tag(s) of a bucket«Validate Icon»
PutBucketVersioningSets the versioning state of an existing bucket«Validate Icon»
PutBucketWebsiteEnables bucket website and sets the basic configuration for the website«Validate Icon»

Object Operations

FeatureDescriptionStatus
DeleteObjectsDelete multiple objects in a single request (up to 1000)«Validate Icon»
DeleteObjectDeletes an object«Validate Icon»
DeleteObjectTaggingDeletes the tag(s) of an object«Validate Icon»
GetObjectRetrieves an object«Validate Icon»
GetObjectAclGets the ACL of an object«Validate Icon»
GetObjectLegalHoldGets an object’s current Legal Hold configuration«Validate Icon»
GetObjectLockConfigurationGets an object Lock configuration for a bucket. The specified rule will be applied by default to every new object placed in the bucket«Validate Icon»
GetObjectRetentionRetrieves an object’s retention settings«Validate Icon»
GetObjectTaggingGet the tag(s) of an object«Validate Icon»
HeadObjectGets object metadata«Validate Icon»
MultipartAll calls related to multipart uploads, such as Initiate, Complete, Abort, List Parts, List Multipart Uploads and Upload Part, are supported«Validate Icon»
OPTIONS objectAllows to send a preflight request to trigger an evaluation of the rules that are defined in the CORS configuration«Validate Icon»
POST objectAdds an object to a bucket by using HTML forms«Validate Icon»
PutObjectAdds an object to a bucket«Validate Icon»
PutObjectAclAdds an ACL to an object«Validate Icon»
PutObjectCopyCopies an object«Validate Icon»
PutObjectTaggingAdds one or several tags to an object«Validate Icon»
PutObjectLegalHoldApplies a Legal Hold configuration to the specified object«Validate Icon»
PutObjectRetentionPlaces an object Retention configuration on an object«Validate Icon»
RestoreObjectRestores an object from Glacier«Validate Icon»
See Also