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.
API method | Description and permission | Query parameters | Request headers |
Get service |
| 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)] |
API method | Description and permission | Query parameters | Request headers |
DELETE 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 |
| 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 |
| 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] |
API method | Description and permission | Query parameters | Request 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 |
| 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 |
| 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 |
| 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) |
API method | Description and permission | Query parameters | Request 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] |