req_user_agent: Set user-agent for a request
In r-lib/httr2: Perform HTTP Requests and Process the Responses

req_user_agent

R Documentation

Set user-agent for a request

Description

This overrides the default user-agent set by httr2 which includes the version numbers of httr2, the curl package, and libcurl.

Usage

req_user_agent(req, string = NULL)

Arguments

`req`	A httr2 request object.
`string`	String to be sent in the `User-Agent` header. If `NULL`, will user default.

Value

A modified HTTP request.

Examples

# Default user-agent:
request("http://example.com") |> req_dry_run()

request("http://example.com") |> req_user_agent("MyString") |> req_dry_run()

# If you're wrapping in an API in a package, it's polite to set the
# user agent to identify your package.
request("http://example.com") |>
  req_user_agent("MyPackage (http://mypackage.com)") |>
  req_dry_run()

r-lib/httr2 documentation built on Nov. 4, 2024, 11:32 p.m.