You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/object-storage/api-cli/using-api-call-list.mdx
+59-64Lines changed: 59 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ content:
7
7
paragraph: Learn how to use the API call list effectively with Scaleway Object Storage.
8
8
tags: object storage object-storage api bucket
9
9
dates:
10
-
validation: 2024-08-05
10
+
validation: 2025-02-28
11
11
posted: 2018-09-13
12
12
categories:
13
13
- storage
@@ -24,84 +24,79 @@ In this page we index all available Scaleway Object Storage API requests.
24
24
When you use Object Storage directly with the API, you must generate an [Authentication Signature v4](/object-storage/api-cli/generate-aws4-auth-signature/) beforehand.
25
25
</Message>
26
26
27
-
Status:
28
-
- Feature available: ✅
29
-
- Feature in development: ⌛
30
-
- Deprecated feature: ❗
31
-
32
27
## Common Operations
33
28
34
29
| Feature | Description | Status |
35
30
| :------------ | :---- | :- |
36
-
|[GetService](/object-storage/api-cli/common-operations/#getservice)| Returns a list of all buckets |✅|
31
+
|[GetService](/object-storage/api-cli/common-operations/#getservice)| Returns a list of all buckets |supported|
|[DeleteBucketCors](/object-storage/api-cli/bucket-operations/#deletebucketcors)| Deletes the [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) configuration of a bucket |✅|
45
-
|[DeleteBucketLifecycle](/object-storage/api-cli/bucket-operations/#deletebucketlifecycle)| Deletes the [lifecycle configuration](/object-storage/api-cli/lifecycle-rules-api/) of a bucket |✅|
46
-
|[DeleteBucketPolicy](/object-storage/api-cli/bucket-operations/#deletebucketpolicy)| Deletes the policy of a specified bucket |✅|
47
-
|[DeleteBucketTagging](/object-storage/api-cli/bucket-operations/#deletebuckettagging)| Deletes the tag(s) of a bucket |✅|
48
-
|[DeleteBucketWebsite](/object-storage/api-cli/bucket-operations/#deletebucketwebsite)| Deletes the bucket website configuration of a specified bucket |✅|
49
-
|[GetBucketAcl](/object-storage/api-cli/bucket-operations/#getbucketacl)| Returns the bucket ACL |✅|
50
-
|[GetBucketCors](/object-storage/api-cli/bucket-operations/#getbucketcors)| Returns the [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) configuration of a bucket |✅|
51
-
| GetBucketLifecycle | Returns the lifecycle configuration information set on the bucket |❗|
52
-
|[GetBucketLifecycleConfiguration](/object-storage/api-cli/bucket-operations/#getbucketlifecycleconfiguration)| Returns the lifecycle configuration information set on a bucket |✅|
53
-
|[GetBucketLocation](/object-storage/api-cli/bucket-operations/#getbucketlocation)| Returns the region where the bucket is |✅|
54
-
| GetBucketNotification | Returns the notification configuration of a bucket |⌛|
55
-
|[GetBucketPolicy](/object-storage/api-cli/bucket-operations/#getbucketpolicy)| Returns the policy of a specified bucket |✅|
56
-
| GetBucketPolicyStatus | Retrieves the policy status for a bucket. The status indicates whether a bucket is public or not |✅|
57
-
|[GetBucketTagging](/object-storage/api-cli/bucket-operations/#getbuckettagging)| Returns the tag(s) of a bucket |✅|
58
-
|[GetBucketVersioning](/object-storage/api-cli/bucket-operations/#getbucketversioning)| Returns the versioning state of a bucket |✅|
59
-
|[GetBucketWebsite](/object-storage/api-cli/bucket-operations/#getbucketwebsite)| Returns the bucket website basic configuration |✅|
60
-
|[HeadBucket](/object-storage/api-cli/bucket-operations/#headbucket)| Checks if the bucket exists |✅|
61
-
|[ListObjects](/object-storage/api-cli/bucket-operations/#listobjects)| Lists objects in the bucket |✅|
62
-
| ListObjectsV2 | Returns some or all (up to 1,000) of the objects in a bucket |✅|
63
-
|[ListObjectVersions](/object-storage/api-cli/bucket-operations/#listobjectversions)| Returns metadata about all the versions of objects in a bucket |✅|
64
-
|[PutBucketAcl](/object-storage/api-cli/bucket-operations/#putbucketacl)| Configures the Access Control List of a bucket |✅|
65
-
|[PutBucketCors](/object-storage/api-cli/bucket-operations/#putbucketcors)| Configures [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) on a bucket |✅|
66
-
| PutBucketLifecycle | Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration |❗|
67
-
| PutBucketLifecycleConfiguration| Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration |✅|
68
-
| PutBucketNotification | Enables notifications of specified events for a bucket |⌛|
69
-
|[PutBucketPolicy](/object-storage/api-cli/bucket-operations/#putbucketpolicy)| Applies an Object Storage bucket policy to an Object Storage bucket. The key elements of bucket policy are [Version](/object-storage/api-cli/bucket-policy/#version), [ID](/object-storage/api-cli/bucket-policy/#id), [Statement](/object-storage/api-cli/bucket-policy/#statement), [Sid](/object-storage/api-cli/bucket-policy/#sid), [Principal](/object-storage/api-cli/bucket-policy/#principal), [Action](/object-storage/api-cli/bucket-policy/#action), [Effect](/object-storage/api-cli/bucket-policy/#effect), [Resource](/object-storage/api-cli/bucket-policy/#resource) and [Condition](/object-storage/api-cli/bucket-policy/#condition). You can find out more about each element by clicking the links, or consulting the full documentation |✅|
70
-
|[PutBucketTagging](/object-storage/api-cli/bucket-operations/#putbuckettagging)| Sets the tag(s) of a bucket |✅|
71
-
|[PutBucketVersioning](/object-storage/api-cli/bucket-operations/#putbucketversioning)| Sets the versioning state of an existing bucket |✅|
72
-
|[PutBucketWebsite](/object-storage/api-cli/bucket-operations/#putbucketwebsite)| Enables bucket website and sets the basic configuration for the website |✅|
|[DeleteBucketCors](/object-storage/api-cli/bucket-operations/#deletebucketcors)| Deletes the [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) configuration of a bucket |supported|
40
+
|[DeleteBucketLifecycle](/object-storage/api-cli/bucket-operations/#deletebucketlifecycle)| Deletes the [lifecycle configuration](/object-storage/api-cli/lifecycle-rules-api/) of a bucket |supported|
41
+
|[DeleteBucketPolicy](/object-storage/api-cli/bucket-operations/#deletebucketpolicy)| Deletes the policy of a specified bucket |supported|
42
+
|[DeleteBucketTagging](/object-storage/api-cli/bucket-operations/#deletebuckettagging)| Deletes the tag(s) of a bucket |supported|
43
+
|[DeleteBucketWebsite](/object-storage/api-cli/bucket-operations/#deletebucketwebsite)| Deletes the bucket website configuration of a specified bucket |supported|
44
+
|[GetBucketAcl](/object-storage/api-cli/bucket-operations/#getbucketacl)| Returns the bucket ACL |supported|
45
+
|[GetBucketCors](/object-storage/api-cli/bucket-operations/#getbucketcors)| Returns the [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) configuration of a bucket |supported|
46
+
| GetBucketLifecycle | Returns the lifecycle configuration information set on the bucket |deprecated|
47
+
|[GetBucketLifecycleConfiguration](/object-storage/api-cli/bucket-operations/#getbucketlifecycleconfiguration)| Returns the lifecycle configuration information set on a bucket |supported|
48
+
|[GetBucketLocation](/object-storage/api-cli/bucket-operations/#getbucketlocation)| Returns the region where the bucket is |supported|
49
+
| GetBucketNotification | Returns the notification configuration of a bucket |in development|
50
+
|[GetBucketPolicy](/object-storage/api-cli/bucket-operations/#getbucketpolicy)| Returns the policy of a specified bucket |supported|
51
+
| GetBucketPolicyStatus | Retrieves the policy status for a bucket. The status indicates whether a bucket is public or not |supported|
52
+
|[GetBucketTagging](/object-storage/api-cli/bucket-operations/#getbuckettagging)| Returns the tag(s) of a bucket |supported|
53
+
|[GetBucketVersioning](/object-storage/api-cli/bucket-operations/#getbucketversioning)| Returns the versioning state of a bucket |supported|
54
+
|[GetBucketWebsite](/object-storage/api-cli/bucket-operations/#getbucketwebsite)| Returns the bucket website basic configuration |supported|
55
+
|[HeadBucket](/object-storage/api-cli/bucket-operations/#headbucket)| Checks if the bucket exists |supported|
56
+
|[ListObjects](/object-storage/api-cli/bucket-operations/#listobjects)| Lists objects in the bucket |supported|
57
+
| ListObjectsV2 | Returns some or all (up to 1,000) of the objects in a bucket |supported|
58
+
|[ListObjectVersions](/object-storage/api-cli/bucket-operations/#listobjectversions)| Returns metadata about all the versions of objects in a bucket |supported|
59
+
|[PutBucketAcl](/object-storage/api-cli/bucket-operations/#putbucketacl)| Configures the Access Control List of a bucket |supported|
60
+
|[PutBucketCors](/object-storage/api-cli/bucket-operations/#putbucketcors)| Configures [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) on a bucket |supported|
61
+
| PutBucketLifecycle | Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration |deprecated|
62
+
| PutBucketLifecycleConfiguration| Creates a new lifecycle configuration or replaces an existing bucket lifecycle configuration |supported|
63
+
| PutBucketNotification | Enables notifications of specified events for a bucket |in development|
64
+
|[PutBucketPolicy](/object-storage/api-cli/bucket-operations/#putbucketpolicy)| Applies an Object Storage bucket policy to an Object Storage bucket. The key elements of bucket policy are [Version](/object-storage/api-cli/bucket-policy/#version), [ID](/object-storage/api-cli/bucket-policy/#id), [Statement](/object-storage/api-cli/bucket-policy/#statement), [Sid](/object-storage/api-cli/bucket-policy/#sid), [Principal](/object-storage/api-cli/bucket-policy/#principal), [Action](/object-storage/api-cli/bucket-policy/#action), [Effect](/object-storage/api-cli/bucket-policy/#effect), [Resource](/object-storage/api-cli/bucket-policy/#resource) and [Condition](/object-storage/api-cli/bucket-policy/#condition). You can find out more about each element by clicking the links, or consulting the full documentation |supported|
65
+
|[PutBucketTagging](/object-storage/api-cli/bucket-operations/#putbuckettagging)| Sets the tag(s) of a bucket |supported|
66
+
|[PutBucketVersioning](/object-storage/api-cli/bucket-operations/#putbucketversioning)| Sets the versioning state of an existing bucket |supported|
67
+
|[PutBucketWebsite](/object-storage/api-cli/bucket-operations/#putbucketwebsite)| Enables bucket website and sets the basic configuration for the website |supported|
73
68
74
69
75
70
76
71
## Object Operations
77
72
78
73
| Feature | Description | Status |
79
74
| :------------ | :---- | :- |
80
-
|[AbortMultipartUpload](/object-storage/api-cli/multipart-uploads/#aborting-a-multipart-upload)| Aborts a multipart upload|✅|
81
-
|[CompleteMultipartUpload](/object-storage/api-cli/multipart-uploads/#completing-a-multipart-upload)| Assembles previously uploaded parts to completes a multipart upload |✅|
82
-
|[CopyObject](/object-storage/api-cli/object-operations/#putobjectcopy)| Copies an object |✅|
83
-
|[CreateMultipart](/object-storage/api-cli/object-operations/#createmultipartupload)| Initiates a multipart upload and returns the upload ID |✅|
84
-
|[DeleteObjects](/object-storage/api-cli/object-operations/#deleteobjects)| Delete multiple objects in a single request (up to 1000) |✅|
85
-
|[DeleteObject](/object-storage/api-cli/object-operations/#deleteobject)| Deletes an object |✅|
86
-
|[DeleteObjectTagging](/object-storage/api-cli/object-operations/#deleteobjecttagging)| Deletes the tag(s) of an object |✅|
87
-
|[GetObject](/object-storage/api-cli/object-operations/#getobject)| Retrieves an object |✅|
88
-
|[GetObjectAcl](/object-storage/api-cli/object-operations/#getobjectacl)| Gets the ACL of an object |✅|
89
-
|[GetObjectLegalHold](/object-storage/api-cli/object-lock/#get-object-legal-hold)| Gets an object's current [Legal Hold configuration](/object-storage/api-cli/object-lock/#how-to-manage-object-legal-hold)|✅|
90
-
|[GetObjectLockConfiguration](/object-storage/api-cli/object-lock/#get-object-lock-configuration)| Gets an [object Lock configuration](/object-storage/api-cli/object-lock/) for a bucket. The specified rule will be applied by default to every new object placed in the bucket |✅|
91
-
|[GetObjectRetention](/object-storage/api-cli/object-lock/#get-object-retention)| Retrieves an object's [retention settings](/object-storage/api-cli/object-lock/#how-to-configure-object-retention)|✅|
92
-
|[GetObjectTagging](/object-storage/api-cli/object-operations/#getobjecttagging)| Get the tag(s) of an object |✅|
|[OPTIONS object](/object-storage/api-cli/object-operations/#options-object)| Allows to send a preflight request to trigger an evaluation of the rules that are defined in the CORS configuration |✅|
96
-
|[POST object](/object-storage/api-cli/object-operations/#post-object)| Adds an object to a bucket by using HTML forms |✅|
97
-
|[PutObject](/object-storage/api-cli/object-operations/#putobject)| Adds an object to a bucket |✅|
98
-
|[PutObjectAcl](/object-storage/api-cli/object-operations/#putobjectacl)| Adds an ACL to an object |✅|
99
-
|[PutObjectTagging](/object-storage/api-cli/object-operations/#putobjecttagging)| Adds one or several tags to an object |✅|
100
-
|[PutObjectLegalHold](/object-storage/api-cli/object-lock/#put-object-legal-hold)| Applies a [Legal Hold configuration](/object-storage/api-cli/object-lock/#how-to-manage-object-legal-hold) to the specified object |✅|
101
-
| PutObjectLockConfiguration | Sets an object lock configuration on a specified bucket |✅|
102
-
|[PutObjectRetention](/object-storage/api-cli/object-lock/#put-object-retention)| Places an [object Retention configuration](/object-storage/api-cli/object-lock/#how-to-configure-object-retention) on an object |✅|
103
-
|[RestoreObject](/object-storage/api-cli/object-operations/#restoreobject)| Restores an object from `Glacier`|✅|
104
-
|[UploadPart](/object-storage/api-cli/multipart-uploads/#uploading-a-part)| Uploads a part in a multipart upload |✅|
105
-
| UploadPartCopy | Copies data from an existing object as data source to upload a part |✅|
75
+
|[AbortMultipartUpload](/object-storage/api-cli/multipart-uploads/#aborting-a-multipart-upload)| Aborts a multipart upload|supported|
76
+
|[CompleteMultipartUpload](/object-storage/api-cli/multipart-uploads/#completing-a-multipart-upload)| Assembles previously uploaded parts to completes a multipart upload |supported|
77
+
|[CopyObject](/object-storage/api-cli/object-operations/#putobjectcopy)| Copies an object |supported|
78
+
|[CreateMultipart](/object-storage/api-cli/object-operations/#createmultipartupload)| Initiates a multipart upload and returns the upload ID |supported|
79
+
|[DeleteObjects](/object-storage/api-cli/object-operations/#deleteobjects)| Delete multiple objects in a single request (up to 1000) |supported|
80
+
|[DeleteObject](/object-storage/api-cli/object-operations/#deleteobject)| Deletes an object |supported|
81
+
|[DeleteObjectTagging](/object-storage/api-cli/object-operations/#deleteobjecttagging)| Deletes the tag(s) of an object |supported|
82
+
|[GetObject](/object-storage/api-cli/object-operations/#getobject)| Retrieves an object |supported|
83
+
|[GetObjectAcl](/object-storage/api-cli/object-operations/#getobjectacl)| Gets the ACL of an object |supported|
84
+
|[GetObjectLegalHold](/object-storage/api-cli/object-lock/#get-object-legal-hold)| Gets an object's current [Legal Hold configuration](/object-storage/api-cli/object-lock/#how-to-manage-object-legal-hold)|supported|
85
+
|[GetObjectLockConfiguration](/object-storage/api-cli/object-lock/#get-object-lock-configuration)| Gets an [object Lock configuration](/object-storage/api-cli/object-lock/) for a bucket. The specified rule will be applied by default to every new object placed in the bucket |supported|
86
+
|[GetObjectRetention](/object-storage/api-cli/object-lock/#get-object-retention)| Retrieves an object's [retention settings](/object-storage/api-cli/object-lock/#how-to-configure-object-retention)|supported|
87
+
|[GetObjectTagging](/object-storage/api-cli/object-operations/#getobjecttagging)| Get the tag(s) of an object |supported|
|[OPTIONS object](/object-storage/api-cli/object-operations/#options-object)| Allows to send a preflight request to trigger an evaluation of the rules that are defined in the CORS configuration |supported|
91
+
|[POST object](/object-storage/api-cli/object-operations/#post-object)| Adds an object to a bucket by using HTML forms |supported|
92
+
|[PutObject](/object-storage/api-cli/object-operations/#putobject)| Adds an object to a bucket |supported|
93
+
|[PutObjectAcl](/object-storage/api-cli/object-operations/#putobjectacl)| Adds an ACL to an object |supported|
94
+
|[PutObjectTagging](/object-storage/api-cli/object-operations/#putobjecttagging)| Adds one or several tags to an object |supported|
95
+
|[PutObjectLegalHold](/object-storage/api-cli/object-lock/#put-object-legal-hold)| Applies a [Legal Hold configuration](/object-storage/api-cli/object-lock/#how-to-manage-object-legal-hold) to the specified object |supported|
96
+
| PutObjectLockConfiguration | Sets an object lock configuration on a specified bucket |supported|
97
+
|[PutObjectRetention](/object-storage/api-cli/object-lock/#put-object-retention)| Places an [object Retention configuration](/object-storage/api-cli/object-lock/#how-to-configure-object-retention) on an object |supported|
98
+
|[RestoreObject](/object-storage/api-cli/object-operations/#restoreobject)| Restores an object from `Glacier`|supported|
99
+
|[UploadPart](/object-storage/api-cli/multipart-uploads/#uploading-a-part)| Uploads a part in a multipart upload |supported|
100
+
| UploadPartCopy | Copies data from an existing object as data source to upload a part |supported|
0 commit comments