Skip to content

Http.Head

Name Mandatory Description Default Type
⬅️ Input The input for this shard should either be none or an optional string table of query parameters to append to the URL. None{String}
Output ➡️ The output is the headers of the response from the server through the HEAD request. {status: Int headers: {String} body: Bytes}Bytes{status: Int headers: {String} body: String}StringObject
URL No The url to request to. `` StringVar(String)
Headers No If a table of headers is provided, it will be used as is; if no headers are provided, a Content-Type header will be derived based on the input type. none None{String}Var({String})
Timeout No How many seconds to wait for the request to complete. 10 Int
Bytes No If instead of a string the shard should output bytes. false Bool
FullResponse No If the output should be a table with the full response, including headers and status. false Bool
AcceptInvalidCerts No If we should ignore invalid certificates. This is useful for testing but should not be used in production. false Bool
Retry No How many times to retry the request if it fails. 0 Int
KeepAlive No If the client instance should be kept alive, allowing connection reuse for multiple requests. The client won't be closed until this shard cleans up. false Bool
Streaming No If the response should be streamed, in which case the output will be an object to use with the Http.Stream shard. false Bool
Backoff No How many seconds to wait between retries. Defaults to 1 second. 1 Int

This shard sends a HEAD request to the specified URL and outputs the response.

Details

This shard can accept a string table as input to append query parameters to the specified URL. For example,

{
  "param1": "value1"
  "param2": "value2"
  "param3": "value3"
} = queryParams

queryParams
Http.Get("https://api.example.com/endpoint")
The Http.Get shard will append the query parameters to the URL and the resulting constructed URL will be: https://api.example.com/endpoint?param1=value1&param2=value2&param3=value3

This shard is similar to the Http.Get shard, but it only returns the headers of the response and not the body.