| Method | HEAD /db/doc | |
| Request | None | |
| Response | None | |
| Admin Privileges Required | no | |
| Query Arguments | Argument | rev |
| Description | Specify the revision to return | |
| Optional | yes | |
| Type | string | |
| Argument | revs | |
| Description | Return a list of the revisions for the document | |
| Optional | yes | |
| Type | boolean | |
| Argument | revs_info | |
| Description | Return a list of detailed revision information for the document | |
| Optional | yes | |
| Type | boolean | |
| Return Codes | ||
| 404 | The specified document or revision cannot be found, or has been deleted | |
Returns the HTTP Headers containing a minimal amount of
information about the specified document. The method supports the
same query arguments as the GET method, but
only the header information (including document size, and the
revision as an ETag), is returned. For example, a simple
HEAD request:
HEAD http://couchdb:5984/recipes/FishStew Content-Type: application/json
Returns the following HTTP Headers:
HTTP/1.1 200 OK Server: CouchDB/1.0.1 (Erlang OTP/R13B) Etag: "7-a19a1a5ecd946dad70e85233ba039ab2" Date: Fri, 05 Nov 2010 14:54:43 GMT Content-Type: text/plain;charset=utf-8 Content-Length: 136 Cache-Control: must-revalidate
The Etag header shows the current revision for
the requested document, and the Content-Length
specifies the length of the data, if the document were requested
in full.
Adding any of the query arguments (as supported by
GET
method), then the resulting HTTP Headers will correspond to what
would be returned. Note that the current revision is not returned
when the refs_info argument is used. For
example:
HTTP/1.1 200 OK Server: CouchDB/1.0.1 (Erlang OTP/R13B) Date: Fri, 05 Nov 2010 14:57:16 GMT Content-Type: text/plain;charset=utf-8 Content-Length: 609 Cache-Control: must-revalidate