Skip to main content
A newer release of this product is available.

Quick reference: Supported S3 API requests

Contributors netapp-madkat netapp-pcarriga
PDFs

This page summarizes how StorageGRID supports Amazon Simple Storage Service (S3) APIs.

This page includes only the S3 operations that are supported by StorageGRID.

Note 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

Related information

AbortMultipartUpload

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional URI query parameter:

  • uploadId

Request body

None

StorageGRID documentation

Operations for multipart uploads

CompleteMultipartUpload

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional URI query parameter:

  • uploadId

Request body XML tags

StorageGRID supports these request body XML tags:

  • CompleteMultipartUpload

  • ETag

  • Part

  • PartNumber

StorageGRID documentation

CompleteMultipartUpload

CopyObject

URI query parameters and request headers

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>

Request body

None

StorageGRID documentation

CopyObject

CreateBucket

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • x-amz-bucket-object-lock-enabled

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on buckets

CreateMultipartUpload

URI query parameters and request headers

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-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>

Request body

None

StorageGRID documentation

CreateMultipartUpload

DeleteBucket

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

StorageGRID documentation

Operations on buckets

DeleteBucketCors

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

DeleteBucketEncryption

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

DeleteBucketLifecycle

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

DeleteBucketPolicy

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

DeleteBucketReplication

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

DeleteBucketTagging

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

DeleteObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional request header:

  • x-amz-bypass-governance-retention

Request body

None

StorageGRID documentation

Operations on objects

DeleteObjects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional request header:

  • x-amz-bypass-governance-retention

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on objects

DeleteObjectTagging

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on objects

GetBucketAcl

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketCors

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketEncryption

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketLifecycleConfiguration

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

GetBucketLocation

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketNotificationConfiguration

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketPolicy

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketReplication

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketTagging

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetBucketVersioning

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

GetObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:

  • 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

Request body

None

StorageGRID documentation

GetObject

GetObjectAcl

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on objects

GetObjectLegalHold

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Use S3 REST API to configure S3 Object Lock

GetObjectLockConfiguration

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Use S3 REST API to configure S3 Object Lock

GetObjectRetention

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Use S3 REST API to configure S3 Object Lock

GetObjectTagging

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on objects

HeadBucket

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

HeadObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • 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

Request body

None

StorageGRID documentation

HeadObject

ListBuckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on the service > ListBuckets

ListMultipartUploads

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • delimiter

  • encoding-type

  • key-marker

  • max-uploads

  • prefix

  • upload-id-marker

Request body

None

StorageGRID documentation

ListMultipartUploads

ListObjects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • delimiter

  • encoding-type

  • marker

  • max-keys

  • prefix

Request body

None

StorageGRID documentation

Operations on buckets

ListObjectsV2

URI query parameters and request headers

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

Request body

None

StorageGRID documentation

Operations on buckets

ListObjectVersions

URI query parameters and request headers

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

Request body

None

StorageGRID documentation

Operations on buckets

ListParts

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • max-parts

  • part-number-marker

  • uploadId

Request body

None

StorageGRID documentation

ListMultipartUploads

PutBucketCors

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on buckets

PutBucketEncryption

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

StorageGRID supports these request body XML tags:

  • ApplyServerSideEncryptionByDefault

  • Rule

  • ServerSideEncryptionConfiguration

  • SSEAlgorithm

StorageGRID documentation

Operations on buckets

PutBucketLifecycleConfiguration

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

StorageGRID supports these request body XML tags:

  • And

  • Days

  • Expiration

  • ExpiredObjectDeleteMarker

  • Filter

  • ID

  • Key

  • LifecycleConfiguration

  • NewerNoncurrentVersions

  • NoncurrentDays

  • NoncurrentVersionExpiration

  • Prefix

  • Rule

  • Status

  • Tag

  • Value

StorageGRID documentation

PutBucketNotificationConfiguration

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

StorageGRID supports these request body XML tags:

  • Event

  • Filter

  • FilterRule

  • Id

  • Name

  • NotificationConfiguration

  • Prefix

  • S3Key

  • Suffix

  • Topic

  • TopicConfiguration

  • Value

StorageGRID documentation

Operations on buckets

PutBucketPolicy

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

For details about the supported JSON body fields, see Use bucket and group access policies.

PutBucketReplication

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

  • Bucket

  • Destination

  • Prefix

  • ReplicationConfiguration

  • Rule

  • Status

  • StorageClass

StorageGRID documentation

Operations on buckets

PutBucketTagging

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on buckets

PutBucketVersioning

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body parameters

StorageGRID supports these request body parameters:

  • VersioningConfiguration

  • Status

StorageGRID documentation

Operations on buckets

PutObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • Cache-Control

  • Content-Disposition

  • Content-Encoding

  • Content-Language

  • 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>

Request body

  • Binary data of the object

StorageGRID documentation

PutObject

PutObjectLegalHold

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Use S3 REST API to configure S3 Object Lock

PutObjectLockConfiguration

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Use S3 REST API to configure S3 Object Lock

PutObjectRetention

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional header:

  • x-amz-bypass-governance-retention

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Use S3 REST API to configure S3 Object Lock

PutObjectTagging

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on objects

RestoreObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

For details about the supported body fields, see RestoreObject.

SelectObjectContent

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

For details about the supported body fields, see the following:

UploadPart

URI query parameters and request headers

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-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

Request body

  • Binary data of the part

StorageGRID documentation

UploadPart

UploadPartCopy

URI query parameters and request headers

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

Request body

None

StorageGRID documentation

UploadPartCopy