Quick reference: Supported S3 API requests
This page summarizes how StorageGRID supports Amazon Simple Storage Service (S3) APIs.
This page includes only the S3 operations that are supported by StorageGRID.
To see the AWS documentation for each operation, select the link in the heading. |
Common URI query parameters and request headers
Unless noted, the following common URI query parameters are supported:
-
versionId
(as required for object operations)
Unless noted, the following common request headers are supported:
-
Authorization
-
Connection
-
Content-Length
-
Content-MD5
-
Content-Type
-
Date
-
Expect
-
Host
-
x-amz-date
AbortMultipartUpload
StorageGRID supports all common parameters and headers for this request, plus this additional URI query parameter:
-
uploadId
None
CompleteMultipartUpload
StorageGRID supports all common parameters and headers for this request, plus this additional URI query parameter:
-
uploadId
-
x-amz-checksum-sha256
StorageGRID supports these request body XML tags:
-
ChecksumSHA256
-
CompleteMultipartUpload
-
ETag
-
Part
-
PartNumber
CopyObject
StorageGRID supports all common parameters and headers for this request, plus these additional headers:
-
x-amz-copy-source
-
x-amz-copy-source-if-match
-
x-amz-copy-source-if-modified-since
-
x-amz-copy-source-if-none-match
-
x-amz-copy-source-if-unmodified-since
-
x-amz-copy-source-server-side-encryption-customer-algorithm
-
x-amz-copy-source-server-side-encryption-customer-key
-
x-amz-copy-source-server-side-encryption-customer-key-MD5
-
x-amz-metadata-directive
-
x-amz-object-lock-legal-hold
-
x-amz-object-lock-mode
-
x-amz-object-lock-retain-until-date
-
x-amz-server-side-encryption
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
x-amz-storage-class
-
x-amz-tagging
-
x-amz-tagging-directive
-
x-amz-meta-<metadata-name>
None
CreateBucket
StorageGRID supports all common parameters and headers for this request, plus these additional headers:
-
x-amz-bucket-object-lock-enabled
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
CreateMultipartUpload
StorageGRID supports all common parameters and headers for this request, plus these additional headers:
-
Cache-Control
-
Content-Disposition
-
Content-Encoding
-
Content-Language
-
Expires
-
x-amz-checksum-algorithm
-
x-amz-server-side-encryption
-
x-amz-storage-class
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
x-amz-tagging
-
x-amz-object-lock-mode
-
x-amz-object-lock-retain-until-date
-
x-amz-object-lock-legal-hold
-
x-amz-meta-<metadata-name>
None
DeleteBucket
StorageGRID supports all common parameters and headers for this request.
DeleteBucketCors
StorageGRID supports all common parameters and headers for this request.
None
DeleteBucketEncryption
StorageGRID supports all common parameters and headers for this request.
None
DeleteBucketLifecycle
StorageGRID supports all common parameters and headers for this request.
None
DeleteBucketPolicy
StorageGRID supports all common parameters and headers for this request.
None
DeleteBucketReplication
StorageGRID supports all common parameters and headers for this request.
None
DeleteBucketTagging
StorageGRID supports all common parameters and headers for this request.
None
DeleteObject
StorageGRID supports all common parameters and headers for this request, plus this additional request header:
-
x-amz-bypass-governance-retention
None
DeleteObjects
StorageGRID supports all common parameters and headers for this request, plus this additional request header:
-
x-amz-bypass-governance-retention
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
DeleteObjectTagging
StorageGRID supports all common parameters and headers for this request.
None
GetBucketAcl
StorageGRID supports all common parameters and headers for this request.
None
GetBucketCors
StorageGRID supports all common parameters and headers for this request.
None
GetBucketEncryption
StorageGRID supports all common parameters and headers for this request.
None
GetBucketLifecycleConfiguration
StorageGRID supports all common parameters and headers for this request.
None
GetBucketLocation
StorageGRID supports all common parameters and headers for this request.
None
GetBucketNotificationConfiguration
StorageGRID supports all common parameters and headers for this request.
None
GetBucketPolicy
StorageGRID supports all common parameters and headers for this request.
None
GetBucketReplication
StorageGRID supports all common parameters and headers for this request.
None
GetBucketTagging
StorageGRID supports all common parameters and headers for this request.
None
GetBucketVersioning
StorageGRID supports all common parameters and headers for this request.
None
GetObject
StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:
-
x-amz-checksum-mode
-
partNumber
-
response-cache-control
-
response-content-disposition
-
response-content-encoding
-
response-content-language
-
response-content-type
-
response-expires
And these additional request headers:
-
Range
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
If-Match
-
If-Modified-Since
-
If-None-Match
-
If-Unmodified-Since
None
GetObjectAcl
StorageGRID supports all common parameters and headers for this request.
None
GetObjectLegalHold
StorageGRID supports all common parameters and headers for this request.
None
GetObjectLockConfiguration
StorageGRID supports all common parameters and headers for this request.
None
GetObjectRetention
StorageGRID supports all common parameters and headers for this request.
None
GetObjectTagging
StorageGRID supports all common parameters and headers for this request.
None
HeadBucket
StorageGRID supports all common parameters and headers for this request.
None
HeadObject
StorageGRID supports all common parameters and headers for this request, plus these additional headers:
-
x-amz-checksum-mode
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
If-Match
-
If-Modified-Since
-
If-None-Match
-
If-Unmodified-Since
-
Range
None
ListBuckets
StorageGRID supports all common parameters and headers for this request.
None
ListMultipartUploads
StorageGRID supports all common parameters and headers for this request, plus these additional parameters:
-
encoding-type
-
key-marker
-
max-uploads
-
prefix
-
upload-id-marker
None
ListObjects
StorageGRID supports all common parameters and headers for this request, plus these additional parameters:
-
delimiter
-
encoding-type
-
marker
-
max-keys
-
prefix
None
ListObjectsV2
StorageGRID supports all common parameters and headers for this request, plus these additional parameters:
-
continuation-token
-
delimiter
-
encoding-type
-
fetch-owner
-
max-keys
-
prefix
-
start-after
None
ListObjectVersions
StorageGRID supports all common parameters and headers for this request, plus these additional parameters:
-
delimiter
-
encoding-type
-
key-marker
-
max-keys
-
prefix
-
version-id-marker
None
ListParts
StorageGRID supports all common parameters and headers for this request, plus these additional parameters:
-
max-parts
-
part-number-marker
-
uploadId
None
PutBucketCors
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
PutBucketEncryption
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports these request body XML tags:
-
ApplyServerSideEncryptionByDefault
-
Rule
-
ServerSideEncryptionConfiguration
-
SSEAlgorithm
PutBucketLifecycleConfiguration
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports these request body XML tags:
-
And
-
Days
-
Expiration
-
ExpiredObjectDeleteMarker
-
Filter
-
ID
-
Key
-
LifecycleConfiguration
-
NewerNoncurrentVersions
-
NoncurrentDays
-
NoncurrentVersionExpiration
-
Prefix
-
Rule
-
Status
-
Tag
-
Value
PutBucketNotificationConfiguration
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports these request body XML tags:
-
Event
-
Filter
-
FilterRule
-
Id
-
Name
-
NotificationConfiguration
-
Prefix
-
S3Key
-
Suffix
-
Topic
-
TopicConfiguration
-
Value
PutBucketPolicy
StorageGRID supports all common parameters and headers for this request.
For details about the supported JSON body fields, see Use bucket and group access policies.
PutBucketReplication
StorageGRID supports all common parameters and headers for this request.
-
Bucket
-
Destination
-
Prefix
-
ReplicationConfiguration
-
Rule
-
Status
-
StorageClass
PutBucketTagging
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
PutBucketVersioning
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports these request body parameters:
-
VersioningConfiguration
-
Status
PutObject
StorageGRID supports all common parameters and headers for this request, plus these additional headers:
-
Cache-Control
-
Content-Disposition
-
Content-Encoding
-
Content-Language
-
x-amz-checksum-sha256
-
x-amz-server-side-encryption
-
x-amz-storage-class
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
x-amz-tagging
-
x-amz-object-lock-mode
-
x-amz-object-lock-retain-until-date
-
x-amz-object-lock-legal-hold
-
x-amz-meta-<metadata-name>
-
Binary data of the object
PutObjectLegalHold
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
PutObjectLockConfiguration
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
PutObjectRetention
StorageGRID supports all common parameters and headers for this request, plus this additional header:
-
x-amz-bypass-governance-retention
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
PutObjectTagging
StorageGRID supports all common parameters and headers for this request.
StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.
RestoreObject
StorageGRID supports all common parameters and headers for this request.
For details about the supported body fields, see RestoreObject.
SelectObjectContent
StorageGRID supports all common parameters and headers for this request.
For details about the supported body fields, see the following:
UploadPart
StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:
-
partNumber
-
uploadId
And these additional request headers:
-
x-amz-checksum-sha256
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
Binary data of the part
UploadPartCopy
StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:
-
partNumber
-
uploadId
And these additional request headers:
-
x-amz-copy-source
-
x-amz-copy-source-if-match
-
x-amz-copy-source-if-modified-since
-
x-amz-copy-source-if-none-match
-
x-amz-copy-source-if-unmodified-since
-
x-amz-copy-source-range
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
-
x-amz-copy-source-server-side-encryption-customer-algorithm
-
x-amz-copy-source-server-side-encryption-customer-key
-
x-amz-copy-source-server-side-encryption-customer-key-MD5
None