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

Description and permission Query parameters Request headers

Service-level operation

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

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

Description: Lists objects and folders in a bucket

Permission: Browse

More information: Listing bucket contents (version 1)

[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

Description: Retrieves the ACL for a bucket

Permission: Read ACL

More information: Retrieving the ACL for 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

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

GET bucket list multipart uploads

Description: Lists in-progress multipart uploads in a bucket

Permission: Browse

More information: Listing the in-progress multipart uploads in a bucket

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

Description: Checks the versioning status of a bucket

Permission: None; requester must be the bucket owner

More information: Checking the versioning status of a bucket

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

Description: Lists versions of objects in a bucket

Permission: Browse

More information: Listing bucket contents (version 1)

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

Description: Checks the existence of a bucket

Permission: Read

More information: Checking the existence of 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

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

Description: Enables or disables versioning for a bucket

Permission: None; requester must be the bucket owner

More information: Enabling or disabling versioning for a bucket

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

DELETE object

Description: Deletes an object or folder

Permission: Delete

More information: Deleting an object or folder

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

Description: Retrieves an object or object version

Permission: Read

More information: Retrieving an 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]
(For formats for datetime-value, see Request headers (GET object))

[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

Description: Retrieves the ACL for an object

Permission: Read ACL

More information: Retrieving the ACL for 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

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

HEAD object

Description: Checks the existence of an object, object version, or folder

Permission: Read

More information: Checking the existence of an object or folder

[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]
   (For formats for datetime-value, see Request headers (HEAD object))

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

[If-Unmodified-Since: datetime-value]

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]
(For formats for datetime-value, see Request headers (PUT object copy))

[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

DELETE object abort multipart upload

Description: Aborts a multipart upload

Permission: Delete

More information: Aborting a 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

Description: Lists the parts that have been uploaded for an in-progress multipart upload

Permission: Read

More information: Listing the parts of a multipart upload

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

Description Completes a multipart upload

Permission: Write

More information: Completing a 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

Description: Initiates a multipart upload

Permission: Write

More information: Initiating a 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

Description: Uploads a part of a multipart upload

Permission: Write

More information: Uploading a part of a multipart upload

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

Description: Uploads a part of a multipart upload by copying all or part of the data for an existing object

Permission: Read for the source object; write for the target bucket

More information: Uploading a part of a multipart object by copying

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]
(For formats for datetime-value, see Request headers (PUT object upload part copy))

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

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.

 

  • Was this article helpful?