HTTP response headers specific to HCP
The next table describes the HTTP response headers specific to HCP.
Header | Methods | Description |
X-HCP-ACL |
HEAD for an object, version, or ACLs GET for objects and object versions | A true or false value indicating whether the object has an ACL. |
X-HCP-ChangeTimeMilliseconds | GET or HEAD for an object, version, or annotation | The change time for the object or annotation, in milliseconds since January 1, 1970, at 00:00:00 UTC, followed by an integer that’s unique for the change time |
X-HCP-ChangeTimeString | GET or HEAD for objects, object versions, and annotations |
The change time for the object or annotation, in this format: yyyy-MM-ddThh:mm:ssZ In this format, Z represents the offset from UTC and is specified as: (+|-)hhmm |
X-HCP-ContentLength | GET with compressed transmission | The length of the returned data before HCP compressed it. |
X-HCP-CurrentStorageNode | HEAD for an object or object version |
The IP address of a node on which object data is stored. You may get better performance retrieving an object if you use this IP address in the GET request for the object instead of using a hostname in the request URL. This header is returned only if both of these are true:
|
X-HCP-Custom-Metadata | GET or HEAD for an object or object version | A true or false value indicating whether the object has any annotations. |
X-HCP-CustomMetadataAnnotations | GET or HEAD for an object or object version |
A comma and space-separated list containing the names and sizes of all object annotations. Each entry in the list consists of the annotation name, a semicolon (;) and the annotation size in bytes, as in report_data;12908. This header is returned only if |
X-HCP-CustomMetadataContentType | GET or HEAD for an object or version data and an annotation together |
The custom metadata type, one of:
|
X-HCP-CustomMetadataFirst | GET for an object or version data and an annotation together |
One of:
|
X-HCP-CustomMetadataHash | PUT for object data and an annotation together |
The cryptographic hash algorithm HCP uses and the cryptographic hash value of the stored annotation, in this format:
You can use the returned hash value to verify that the stored annotation is the same as the custom metadata you sent. To do this, compare this value with a hash value that you generate from the original custom metadata. |
X-HCP-DataContentType | GET for and object or version data and an annotation together |
The Internet media type of the object, such as |
X-HCP-Domain | GET or HEAD for an object or version |
The Active Directory domain that contains the user account identified by the This value is an empty string if the If the |
X-HCP-DPL | GET or HEAD for an object or version | The data protection level of the object or version. |
X‑HCP-ErrorMessage | All |
Detailed information about the cause of an error. This header is returned only if a request results in a 400, 403, or 503 error code and HCP has specific information about the cause. |
X-HCP-GID | GET or HEAD for an object or version |
The POSIX group ID for the object. For objects added through the NFS protocol, this value is determined by the NFS client. This value is an empty string if either of these are true:
|
X-HCP-Hash |
HEAD and GET for an object, version, or annotation PUT for an object or annotation |
The cryptographic hash algorithm the namespace uses, along with a cryptographic hash value of the stored object or annotation:
You can use the returned hash value to verify that the stored data is the same as the data you sent. To do this, compare this value with a hash value that you generate from the original data. The |
X-HCP-Index | HEAD and GET for objects and object versions | A true or false value indicating whether the object is marked for indexing. |
X-HCP-IngestProtocol | HEAD and GET for objects and object versions |
The namespace access protocol through which the object was added to the namespace. One of:
If HCP cannot determine the protocol through which the object was added, this value is |
X-HCP-IngestTime | HEAD and GET for objects and object versions | The time when HCP stored the object, in seconds since January 1, 1970, at 00:00:00 UTC. |
X-HCP-LabelRetentionHold | HEAD and GET for objects | A Boolean value (true |false ) indicating whether the object is on labeled hold. |
X-HCP-LabelRetentionHold-Labels | HEAD and GET for objects |
If the object is on labeled hold ( Example X-HCP-LabelRetentionHold-Labels: [{"id":"UniqueLabelHold-1","hold":true}, {"id":"UniqueLabelHold-2","hold":true}, {"id":"UniqueLabelHold-3","hold":true}] |
X-HCP-Owner | HEAD and GET for objects and object versions |
The user that owns the object. This value can be one of:
|
X-HCP-Replicated | HEAD and GET for objects and object versions |
A HCP returns this header only if either of these is true:
|
X-HCP-ReplicationCollision | HEAD and GET for objects and object versions | A true or false value indicating whether the object is flagged as a replication collision. |
X-HCP-Retention | HEAD and GET for objects and object versions | The end of the retention period for the object, in seconds since January 1, 1970, at 00:00:00 UTC. This value can also be 0 , -1 , or -2 . |
X-HCP-RetentionClass | HEAD and GET for objects and object versions | The name of the retention class to which the object belongs. This value is an empty string if the object is not in a retention class. |
X-HCP-RetentionHold | HEAD and GET for objects and object versions | A true or false value indicating whether the object is on hold. |
X-HCP-RetentionString | HEAD and GET for objects and object versions |
The end of the retention period for the object, in this format: yyyy-MM-ddThh:mm:ssZ In this format, Z represents the offset from UTC and is specified as: (+|-)hhmm For example, 2015-11-16T14:27:20-0500 represents the start of the 20th second into 2:27 PM, November 16, 2015, EST. The value can also be |
X-HCP-ServicedBySystem | All except GET for namespace information |
The domain name of the HCP system responding to the request. If the target HCP system is unable to respond to the request and also participates in replication, this value may be another system in the replication topology. |
X-HCP-Shred | HEAD and GET for objects and object versions | A true or false value indicating whether HCP will shred the object after it is deleted. |
X-HCP-Size | HEAD and GET for objects, object versions, and annotations | The size of the object, version, or annotation, in bytes. For whole-object data, this value is the size of the object data. |
X-HCP-SoftwareVersion | HEAD and GET for objects, object versions, annotations, ACLs, and directories | The version number of the HCP software. |
X-HCP-SymlinkTarget | HEAD and GET |
The path to the target object or directory as specified when the symbolic link was created. This header is returned only if the URL specifies a symbolic link to an object or directory. |
X-HCP-Time | All except POST | The time at which HCP sent the response to the request, in seconds since January 1, 1970, at 00:00:00 UTC. |
X-HCP-Type | HEAD and GET for objects, object versions, annotations, and directories |
The entity type. One of:
|
X-HCP-UID | HEAD and GET for objects and object versions |
The POSIX user ID for the object. For objects added through the NFS protocol, this value is determined by the NFS client. This value is an empty string if either of these are true:
|
X-HCP-VersionId |
HEAD and GET for objects and object versions PUT for objects and object versions | The version ID of the object. |