HEAD
Checks existence of:
- Objects
- Versions
- Directories
- Annotations
- ACLs
Retrieves metadata for:
- Objects
- Versions
Permissions
For all operations: read
To check existence of ACLs: read or read ACL
Elements
For all operations:
Authorization
header- Object, directory, or symbolic link URL
To conditionally check the existence of an object or version, these headers:
If-Match: etag-list
If-None-Match: etag-list
If-Modified-Since: datetime
If-None-Modified-Since: datetime
To check a specific version or the annotation for a specific version, this URL query parameter:
version=version-id
To check an annotation, these URL query parameters:
type=custom-metadata annotation=annotation-name
The annotation name is optional for the default annotation.
To check ACLs, this URL query parameter:
type=acl
To include or exclude the X-HCP-Replicated
header in the response, this header:
X-HCP-Get-Replicated: true|false
Response headers
General
X-HCP-Time
X-HCP-SoftwareVersion
X-HCP-ServicedBySystem
X-HCP-SymlinkTarget
(if URL is a symbolic link)
X-HCP-ErrorMessage
(if an error occurred and more information is available)
Objects, versions, directories, and annotations:
-
X-HCP-ChangeTimeMilliseconds
X-HCP-ChangeTimeString
Objects, versions, and annotations:
ETag
Objects and versions:
X-HCP-ACL
X-HCP- CurrentStorageNode
X-HCP-Custom-Metadata
X-HCP-CustomMetadataAnnotations
X-HCP-Domain
X-HCP-DPL
X-HCP-GID
X-HCP-Hash
(not returned for multipart objects)
X-HCP-Index
X-HCP-IngestProtocol
X-HCP-IngestTime
X-HCP-LabelRetentionHold
X-HCP-LabelRetentionHold-Labels
X-HCP-Owner
X-HCP-Replicated
X-HCP-Retention
X-HCP-RetentionClass
X-HCP-RetentionHold
X-HCP-RetentionString
X-HCP-Shred
X-HCP-Size
X-HCP-Type
X-HCP-UID
X-HCP-VersionID
Directories:
X-HCP-Hash
X-HCP-Size
X-HCP-Type
ACLs:
X-HCP-ACL
Return codes
Success: 200, 204
Error: 304, 400, 403, 404, 412, 414, 500, 503