resp_headers()
retrieves a list of all headers.resp_header()
retrieves a single header.resp_header_exists()
checks if a header is present.
Usage
resp_headers(resp, filter = NULL)
resp_header(resp, header, default = NULL)
resp_header_exists(resp, header)
Arguments
- resp
A httr2 response object, created by
req_perform()
.- filter
A regular expression used to filter the header names.
NULL
, the default, returns all headers.- header
Header name (case insensitive)
- default
Default value to use if header doesn't exist.
Value
resp_headers()
returns a list.resp_header()
returns a string if the header exists andNULL
otherwise.resp_header_exists()
returnsTRUE
orFALSE
.
Examples
resp <- request("https://httr2.r-lib.org") |> req_perform()
resp |> resp_headers()
#> <httr2_headers>
#> server: GitHub.com
#> content-type: text/html; charset=utf-8
#> last-modified: Wed, 05 Mar 2025 14:53:20 GMT
#> access-control-allow-origin: *
#> etag: W/"67c86560-4b1b"
#> expires: Sat, 08 Mar 2025 17:54:26 GMT
#> cache-control: max-age=600
#> content-encoding: gzip
#> x-proxy-cache: MISS
#> x-github-request-id: FA55:171F:2D82BE:34B181:67CC81F8
#> accept-ranges: bytes
#> date: Sat, 08 Mar 2025 18:42:28 GMT
#> via: 1.1 varnish
#> age: 273
#> x-served-by: cache-iad-kcgs7200097-IAD
#> x-cache: HIT
#> x-cache-hits: 5
#> x-timer: S1741459349.945380,VS0,VE1
#> vary: Accept-Encoding
#> x-fastly-request-id: 9b4929b0c4905c43457a2df28a31dff25e9b8384
#> content-length: 4736
resp |> resp_headers("x-")
#> <httr2_headers>
#> x-proxy-cache: MISS
#> x-github-request-id: FA55:171F:2D82BE:34B181:67CC81F8
#> x-served-by: cache-iad-kcgs7200097-IAD
#> x-cache: HIT
#> x-cache-hits: 5
#> x-timer: S1741459349.945380,VS0,VE1
#> x-fastly-request-id: 9b4929b0c4905c43457a2df28a31dff25e9b8384
resp |> resp_header_exists("server")
#> [1] TRUE
resp |> resp_header("server")
#> [1] "GitHub.com"
# Headers are case insensitive
resp |> resp_header("SERVER")
#> [1] "GitHub.com"
# Returns NULL if header doesn't exist
resp |> resp_header("this-header-doesnt-exist")
#> NULL