Skip to main content
Hitachi Vantara Knowledge

Quick reference

This topic contains a quick reference to the S3 compatible API methods. For each method, the topic shows:

  • The query parameters you can use in requests that use the method. Required parameters are listed first followed by optional parameters enclosed in square brackets ([]).
  • The request headers for requests that use the method. Required headers are listed first followed by optional headers enclosed in square brackets.

The methods are grouped by the level of access (service (that is, tenant), bucket, or object, with methods for multipart uploads in a separate group at the end). Within each group, the methods are presented in alphabetical order.

For general information on S3 compatible API requests, see Request line.

Service-level operation
API methodDescription and permissionQuery parametersRequest headers
Get service
  • Description

    Returns a list of buckets owned by the requester

  • Permission

    None; requester must be an authenticated user

  • More information

    Listing the buckets you own

N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

Bucket-level operations
API methodDescription and permissionQuery parametersRequest headers
DELETE bucket
  • Description

    Deletes a bucket

  • Permission

    None; requester must be the bucket owner

  • More information

    Deleting a bucket

N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

GET bucket

[delimiter=string]

[marker=string]

[max-keys=integer]

[prefix=string]

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss (+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss (+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

GET bucket ACL acl

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss (+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss (+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

GET bucket list multipart uploads

uploads

[delimiter=string]

[key-marker=

string]

[max-uploads=

integer]

[prefix=string]

[upload-id-marker=

integer]

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

GET bucket versioning versioning

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

GET bucket versions

versions

[delimiter=string]

[key-marker=

string]

[max-keys=integer]

[prefix=string]

[version-id-marker=

integer]

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

HEAD bucket N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

PUT bucket
  • Description

    Creates a bucket and optionally adds an ACL to it

  • Permission

    None; requester must be an authenticated user

  • More information

    Creating a bucket

N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Content-Length: 0

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-amz-acl: canned-acl-name]

[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

PUT bucket ACL
  • Description

    Adds an ACL to a bucket; removes an ACL from a bucket; changes the bucket owner

  • Permission

    To add or remove an ACL, write ACL; to change the bucket owner, write ACL and change owner

  • More information

    Adding an ACL to a bucket

acl

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[Content-Length:

acl-request-body-size-in-bytes]

(Required with an ACL request body)

[Content-Type: application/xml]

OR

[Content-Type: text/xml]

[x-amz-acl: canned-acl-name]

[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

PUT bucket versioning versioning

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Content-Length:

versioning-request-body-size-in-bytes

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[Content-Type: application/xml]

OR

[Content-Type: text/xml]

Object-level operations
API methodDescription and permissionQuery parametersRequest headers
DELETE object N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

GET object [versionId= version-id]

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[If-Match: "value"[, "value"]...]

[If-Modified-Since: datetime-value]

[If-None-Match: "value"[, "value"]...]

[If-Unmodified-Since: datetime-value]

[response-cache-control:

cache-control-header-value]

[response-content-disposition:

content-disposition-header-value]

[response-content-encoding:

content-encoding-header-value]

[response-content-language:

content-language-header-value]

[response-content-type:

content-type-header-value]

[response-expires: expires-header-value]

GET object ACL acl

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

HEAD object [versionId= version-id]

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[If-Match: "value"[, "value"]...]

[If-Modified-Since: datetime-value]

[If-None-Match: "value"[, "value"]...]

[If-Unmodified-Since: datetime-value]

POST object N/A

Authorization: AWS access-key:signature

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-amz-server-side-encryption:

character-string]

PUT object
  • Description

    Stores an object or new version of an object

  • Permission

    Write

  • More information

    Storing an object

N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Content-Length: data-size-in-bytes

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[Content-MD5:

base64-encoded-md5-hash-of-data]

[Content-Type: internet-media-type]

[Expect: 100-continue]

[x-amz-acl: canned-acl-name]

[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-meta-property-name: value]

[x-amz-server-side-encryption:

character-string]

PUT object ACL
  • Description

    Adds an ACL to an object; removes an ACL from an object; changes the object owner

  • Permission

    To add or remove an ACL, write ACL; to change the object owner, write ACL and change owner

  • More information

    Adding an ACL to an object

acl

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[Content-Length:

acl-request-body-size-in-bytes]

(Required with an ACL request body)

[Content-Type: application/xml]

OR

[Content-Type: text/xml]

[x-amz-acl: canned-acl-name]

[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

PUT object copy
  • Description

    Copies an object; replaces custom metadata for an object

  • Permission

    Read for the source object; write for the target bucket

  • More information

    Copying an object

N/A

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

x-amz-copy-source:

/bucket-name/source-object-name

[?versionId=source-object-version-id]

[Content-Type: internet-media-type]

[x-amz-acl: canned-acl-name]

[x-amz-copy-source-if-match:

"value"[, "value"]...]

[x-amz-copy-source-if-modified-since:

datetime-value]

[x-amz-copy-source-if-none-match:

"value"[, "value"]...]

[x-amz-copy-source-if-unmodified-since:

datetime-value]

[x-amz-server-side-encryption:

character-string]

[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-meta-property-name: value]

[x-amz-metadata-directive: (COPY|REPLACE)

Multipart upload operations
API methodDescription and permissionQuery parametersRequest headers
DELETE object abort multipart upload uploadId=upload-id

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

GET object list parts

uploadId=upload-id

[max-parts=

integer]

[part-number-

marker=integer]

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-hcp-pretty-print: (true|false)]

POST object complete multipart upload uploadId=upload-id

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Content-Length: complete-multipart-upload- request-body-size-in-bytes

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

If-Match: value

[Content-Type: application/xml]

OR

[Content-Type: text/xml]

[x-hcp-pretty-print: (true|false)]

POST object initiate multipart upload uploads

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[x-amz-acl: canned-acl-name]

[x-amz-grant-full-control:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-read-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-grant-write-acp:

identifier-type=grantee-identifier

[, identifier-type=grantee-identifier]...]

[x-amz-meta-property-name: value]

[x-hcp-pretty-print: (true|false)]

PUT object upload part

partNumber=

integer

uploadID=upload-id

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Content-Length: data-size-in-bytes

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

[Content-MD5:

base64-encoded-md5-hash-of-data]

[Content-Type: internet-media-type]

[Expect: 100-continue]

PUT object upload part copy

partNumber=

integer

uploadID=upload-id

Authorization: AWS access-key:signature

OR

Authorization: AD ad-username:ad-password

OR

Authorization: HCP access-key:secret-key

Date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

OR

x-amz-date: DDD, dd MMM yyyy HH:mm:ss

(+0000|GMT)

Host: hostname.hcp-domain-name

x-amz-copy-source:

/bucket-name/source-object-name

[?versionId=source-object-version-id]

[Content-Type: internet-media-type]

[x-amz-copy-source-if-match:

"value"[, "value"]...]

[x-amz-copy-source-if-modified-since:

datetime-value]

[x-amz-copy-source-if-none-match:

"value"[, "value"]...]

[x-amz-copy-source-if-unmodified-since:

datetime-value]

[x-amz-copy-source-range:

start-position-end-position]

 

  • Was this article helpful?