http head

For network.

Get the headers from a URL.

Command Type

built-in

Signature

> http head {flags} (URL)

Flags

  • --user, -u {any}: The username when authenticating.
  • --password, -p {any}: The password when authenticating.
  • --max-time, -m {duration}: Max duration before timeout occurs.
  • --headers, -H {any}: Custom headers you want to add.
  • --full, -f: Returns the full response instead of only the headers.
  • --insecure, -k: Allow insecure server connections when using SSL.
  • --allow-errors, -e: Do not fail if the server returns an error code.
  • --pool: Using a global pool as a client.
  • --redirect-mode, -R {string}: What to do when encountering redirects. Default: ‘follow’. Valid options: ‘follow’ (‘f’), ‘manual’ (‘m’), ‘error’ (‘e’).
  • --unix-socket, -U {path}: Connect to the specified Unix socket instead of using TCP.

Parameters

  • URL: The URL to fetch the contents from.

Input/output types:

input output
nothing any

Examples

Get headers from example.com.

> http head https://www.example.com

Get headers from example.com, with username and password.

> http head --user myuser --password mypass https://www.example.com

Get headers from example.com, with custom header using a record.

> http head --headers {my-header-key: my-header-value} https://www.example.com

Get headers from example.com, with custom header using a list.

> http head --headers [my-header-key-A my-header-value-A my-header-key-B my-header-value-B] https://www.example.com

Notes

Performs HTTP HEAD operation.

Ported from nushell/nushell.github.io. Copyright (c) 2021 Nushell Project. MIT License.