HTTP.HEAD
Create an HTTP HEAD request. The HTTP HEAD method requests HTTP headers from the server as if the document was requested using the HTTP GET method. The only difference between HTTP HEAD and GET requests is that for HTTP HEAD, the server only returns headers without body. This function is asynchronous, therefore the result will be returned when it is available.
Syntax
=HTTP.HEAD(URL, [HeadersJSON], [ConfigJSON], [Target])
Arguments
| Name | Description |
|---|---|
| URL | The URL to request. |
| HeadersJSON (optional) | Headers of the HTTP request. |
| ConfigJSON (optional) | A JSON configuration for the HTTP request. Possible configurations are: "baseURL","timeout","auth: { username: 'secret', password: 'tops3cret' }","proxy: {protocol: 'https',host: '127.0.0.1',port: 9000, auth: {username: 'secret', password: 'tops3cret' } " |
| Target (optional) | INBOX(), OUTBOX("MsgID") or a cell range where the result will be placed. Make sure the cell range is big enough or not everything is displayed. |
Return
The function HTTP.HEAD() always returns a unique random request ID. Otherwise an error is displayed.
Examples
Examples for using the config and header parameter. Use a JSON() function around the cell range.
| Formula | Result | Comment |
|---|---|---|
| Request to the API | A request has been made and put the response into the inbox. the response will only return header. |