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 andNULLotherwise.resp_header_exists()returnsTRUEorFALSE.
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: Tue, 24 Sep 2024 17:20:30 GMT
#> access-control-allow-origin: *
#> etag: W/"66f2f4de-4983"
#> expires: Thu, 26 Sep 2024 10:53:19 GMT
#> cache-control: max-age=600
#> content-encoding: gzip
#> x-proxy-cache: MISS
#> x-github-request-id: DED6:140203:B7AEDD:C8ECDD:66F53AC2
#> accept-ranges: bytes
#> date: Thu, 26 Sep 2024 12:36:16 GMT
#> via: 1.1 varnish
#> age: 19
#> x-served-by: cache-nyc-kteb1890055-NYC
#> x-cache: HIT
#> x-cache-hits: 4
#> x-timer: S1727354177.590283,VS0,VE0
#> vary: Accept-Encoding
#> x-fastly-request-id: 71e4791f9779138c9a33581431ecb446fde8ffa6
#> content-length: 4636
resp |> resp_headers("x-")
#> <httr2_headers>
#> x-proxy-cache: MISS
#> x-github-request-id: DED6:140203:B7AEDD:C8ECDD:66F53AC2
#> x-served-by: cache-nyc-kteb1890055-NYC
#> x-cache: HIT
#> x-cache-hits: 4
#> x-timer: S1727354177.590283,VS0,VE0
#> x-fastly-request-id: 71e4791f9779138c9a33581431ecb446fde8ffa6
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