HTTP::Tiny(3)
π
HTTP::Tiny β manual page HTTP::Tiny(3) β¨
This is the HTTP::Tiny(3) page from the User Contributed Perl Documentation, bestie. π Buckle up, because this tiny client is lowkey iconic.
πΈ NAME πΈ
HTTP::Tiny β A small, simple, correct HTTP/1.1 client. No cap, that's literally the whole vibe. π«Ά
π VERSION π
version 0.096
π SYNOPSIS π
use HTTP::Tiny;
my $response = HTTP::Tiny->new->get('http://example.com/');
die "Failed!\n" unless $response->{success};
print "$response->{status} $response->{reason}\n";
while (my ($k, $v) = each %{$response->{headers}}) {
for (ref $v eq 'ARRAY' ? @$v : $v) {
print "$k: $_\n";
}
}
print $response->{content} if length $response->{content};
π¦ DESCRIPTION π¦
Okay so this is a very simple HTTP/1.1 client, designed for doing simple requests without the overhead of a large framework like LWP::UserAgent. It's giving lightweight main character energy. β¨
It is more correct and more complete than HTTP::Lite. It supports proxies and redirection. It also correctly resumes after EINTR. Fr fr, that part matters.
If IO::Socket::IP 0.25 or later is installed, HTTP::Tiny will use it instead of IO::Socket::INET for transparent support for both IPv4 and IPv6. Slay. π
Cookie support requires HTTP::CookieJar or an equivalent class. πͺ
π METHODS π
π new
$http = HTTP::Tiny->new( %attributes );
This constructor returns a new HTTP::Tiny object. Valid attributes include:
agentβ A user-agent string (defaults to"HTTP-Tiny/$VERSION"). Ifagentends in a space character, the default user-agent string is appended.allow_credentialed_redirectsβ If a3XXredirects to a different scheme, host or port, by defaultHTTP::Tinywill strip away caller-suppliedAuthorization,CookieandProxy-Authorizationheaders from the redirected request and from all subsequent requests in the chain. Set this to a true value to revert to the legacy behavior of forwarding those headers. Default isfalse.allow_downgradeβ If a3XXredirect changes the scheme fromhttpsto plainhttp,HTTP::Tinywill by default refuse to follow it, returning the3XXresponse. Set this to a true value to revert to the legacy behavior of redirectinghttpstohttp. Default isfalse.cookie_jarβ An instance ofHTTP::CookieJarβ or equivalent class that supports theaddandcookie_headermethodsdefault_headersβ A hashref of default headers to apply to requestslocal_addressβ The local IP address to bind tokeep_aliveβ Whether to reuse the last connection (if for the same scheme, host and port) (defaults to1)keep_alive_timeoutβ How many seconds to keep a connection available for after a request (defaults to0, unlimited)max_redirectβ Maximum number of redirects allowed (defaults to5)max_sizeβ Maximum response size in bytes (only when not using a data callback). If defined, requests with responses larger than this will return a599status code.http_proxyβ URL of a proxy server to use for HTTP connections (default is$ENV{http_proxy}β if set)https_proxyβ URL of a proxy server to use for HTTPS connections (default is$ENV{https_proxy}β if set)proxyβ URL of a generic proxy server for both HTTP and HTTPS connections (default is$ENV{all_proxy}β if set)no_proxyβ List of domain suffixes that should not be proxied. Must be a comma-separated string or an array reference. (default is$ENV{no_proxy})timeoutβ Request timeout in seconds (default is60) If a socket open, read or write takes longer than the timeout, the request response status code will be599.verify_SSLβ A boolean that indicates whether to validate the TLS/SSL certificate of anhttpsβ connection (default is true). Changed from false to true in version0.083.SSL_optionsβ A hashref ofSSL_*β options to pass through toIO::Socket::SSL$ENV{PERL_HTTP_TINY_SSL_INSECURE_BY_DEFAULT}β Changes the default certificate verification behavior to not check server identity if set to1. Only effective ifverify_SSLis not set. Added in version0.083.
An accessor/mutator method exists for each attribute.
Passing an explicit undef for proxy, http_proxy or https_proxy will prevent getting the corresponding proxies from the environment.
Errors during request execution will result in a pseudo-HTTP status code of 599 and a reason of Internal Exception. The content field in the response will contain the text of the error. π
The keep_alive parameter enables a persistent connection, but only to a single destination scheme, host and port. If any connection-relevant attributes are modified via accessor, or if the process ID or thread ID change, the persistent connection will be dropped. If you want persistent connections across multiple destinations, use multiple HTTP::Tiny objects. Bestie, don't share one object across everything and expect magic. π
The keep_alive_timeout parameter allows you to control how long a keep alive connection will be considered for reuse. By setting this lower than the server keep alive time, this allows you to avoid race conditions where the server closes the connection while preparing to write the request on a reused persistent connection.
See TLS/SSL SUPPORT for more on the verify_SSL and SSL_options attributes.
π get|head|put|post|patch|delete
$response = $http->get($url);
$response = $http->get($url, \%options);
$response = $http->head($url);
These methods are shorthand for calling request() for the given method. The URL must have unsafe characters escaped and international domain names encoded. See request() for valid options and a description of the response.
The success field of the response will be true if the status code is 2XX. β¨
π post_form
$response = $http->post_form($url, $form_data);
$response = $http->post_form($url, $form_data, \%options);
This method executes a POST request and sends the key/value pairs from a form data hash or array reference to the given URL with a content-type of application/x-www-form-urlencoded. If data is provided as an array reference, the order is preserved; if provided as a hash reference, the terms are sorted by key for consistency. See documentation for the www_form_urlencode method for details on the encoding.
The URL must have unsafe characters escaped and international domain names encoded. See request() for valid options and a description of the response. Any content-type header or content in the options hashref will be ignored.
The success field of the response will be true if the status code is 2XX. π«Ά
π¦ mirror
$response = $http->mirror($url, $file, \%options)
if ( $response->{success} ) {
print "$file is up to date\n";
}
Executes a GET request for the URL and saves the response body to the file name provided. The URL must have unsafe characters escaped and international domain names encoded. If the file already exists, the request will include an If-Modified-Since header with the modification timestamp of the file. You may specify a different If-Modified-Since header yourself in the $options->{headers} hash.
The success field of the response will be true if the status code is 2XX or if the status code is 304 (unmodified).
If the file was modified and the server response includes a properly formatted Last-Modified header, the file modification time will be updated accordingly. Iconic file-syncing behavior, honestly. π
π request
$response = $http->request($method, $url);
$response = $http->request($method, $url, \%options);
Executes an HTTP request of the given method type ('GET', 'HEAD', 'POST', 'PUT', etc.) on the given URL. The URL must have unsafe characters escaped and international domain names encoded.
NOTE: Method names are case-sensitive per the HTTP/1.1 specification. Don't usegetwhen you really wantGET. SeeLIMITATIONSfor how this applies to redirection. π
If the URL includes a user:password stanza, they will be used for Basic-style authorization headers. For example:
$http->request('GET', 'http://Aladdin:open sesame@example.com/');
If the user:password stanza contains reserved characters, they must be percent-escaped:
$http->request('GET', 'http://john%40example.com:password@example.com/');
Caller-supplied Authorization, Cookie and Proxy-Authorization headers are stripped on cross-origin redirects. See new's allow_credentialed_redirects attribute to opt out.
A hashref of options may be appended to modify the request.
Valid options are:
headersβ A hashref containing headers to include with the request. If the value for a header is an array reference, the header will be output multiple times with each value in the array. These headers over-write any default headers.contentβ A scalar to include as the body of the request OR a code reference that will be called iteratively to produce the body of the requesttrailer_callbackβ A code reference that will be called if it exists to provide a hashref of trailing headers (only used with chunked transfer-encoding)data_callbackβ A code reference that will be called for each chunk of the response body received.peerβ Override host resolution and force all connections to go only to a specific peer address, regardless of the URL of the request. This will include any redirections! This options should be used with extreme caution (e.g. debugging or very special circumstances). It can be given as either a scalar or a code reference that will receive the hostname and whose response will be taken as the address.
The Host header is generated from the URL in accordance with RFC 2616. It is a fatal error to specify Host in the headers option. Other headers may be ignored or overwritten if necessary for transport compliance.
If the content option is a code reference, it will be called iteratively to provide the content body of the request. It should return the empty string or undef when the iterator is exhausted.
If the content option is the empty string, no content-type or content-length headers will be generated.
If the data_callback option is provided, it will be called iteratively until the entire response body is received. The first argument will be a string containing a chunk of the response body, the second argument will be the in-progress response hash reference, as described below. (This allows customizing the action of the callback based on the status or headers received prior to the content body.)
Content data in the request/response is handled as "raw bytes". Any encoding/decoding (with associated headers) are the responsibility of the caller. π Like, HTTP::Tiny does not do your character encoding homework for you β that's on you, bestie.
The request method returns a hashref containing the response. That hashref will have the following keys:
successβ Boolean indicating whether the operation returned a2XXstatus code β¨urlβ URL that provided the response. This is the URL of the request unless there were redirections, in which case it is the last URL queried in a redirection chainstatusβ The HTTP status code of the responsereasonβ The response phrase returned by the servercontentβ The body of the response. If the response does not have any content or if a data callback is provided to consume the response body, this will be the empty stringheadersβ A hashref of header fields. All header field names will be normalized to be lower case. If a header is repeated, the value will be an arrayref; it will otherwise be a scalar string containing the valueprotocolβ If this field exists, it is the protocol of the response such asHTTP/1.0orHTTP/1.1redirectsβ If this field exists, it is an arrayref of response hash references from redirects in the same order that redirections occurred. If it does not exist, then no redirections occurred.
On an error during the execution of the request, thestatusfield will contain599, and thecontentfield will contain the text of the error. π So if you're seeing a599bestie, that's not a real HTTP code, that's HTTP::Tiny itself telling you something went sideways.
π www_form_urlencode
$params = $http->www_form_urlencode( $data );
$response = $http->get("http://example.com/query?$params");
This method converts the key/value pairs from a data hash or array reference into a x-www-form-urlencoded string. The keys and values from the data reference will be UTF-8 encoded and escaped per RFC 3986. If a value is an array reference, the key will be repeated with each of the values of the array reference. If data is provided as a hash reference, the key/value pairs in the resulting string will be sorted by key and value for consistent ordering. π₯ (yes, deterministic output, we love to see it)
π¦ can_ssl
$ok = HTTP::Tiny->can_ssl;
($ok, $why) = HTTP::Tiny->can_ssl;
($ok, $why) = $http->can_ssl;
Indicates if SSL support is available. When called as a class object, it checks for the correct version of Net::SSLeay and IO::Socket::SSL. When called as an object method, if SSL_verify is true or if SSL_verify_mode is set in SSL_options, it checks that a CA file is available.
In scalar context, returns a boolean indicating if SSL is available. In list context, returns the boolean and a (possibly multi-line) string of errors indicating why SSL isn't available. π Handy for when you need the receipts on why your https just isn't happening.
πΈ connected
$host = $http->connected;
($host, $port) = $http->connected;
Indicates if a connection to a peer is being kept alive, per the keep_alive option.
In scalar context, returns the peer host and port, joined with a colon, or undef (if no peer is connected). In list context, returns the peer host and port or an empty list (if no peer is connected).
Note: This method cannot reliably be used to discover whether the remote host has closed its end of the socket. π Like it's giving "connection status" but it is not a health check, okurrr?
π TLS/SSL SUPPORT
Direct https connections are supported only if IO::Socket::SSL 1.56 or greater and Net::SSLeay 1.49 or greater are installed. An error will occur if new enough versions of these modules are not installed or if the TLS encryption fails. You can also use HTTP::Tiny::can_ssl() utility function that returns boolean to see if the required modules are installed. β¨
An https connection may be made via an http proxy that supports the CONNECT command (i.e. RFC 2817). You may not proxy https via a proxy that itself requires https to communicate. π«Ά
TLS/SSL provides two distinct capabilities:
- Encrypted communication channel π
- Verification of server identity π
By default, HTTP::Tiny verifies server identity.
This was changed in version0.083due to security concerns. The previous default behavior can be enabled by setting$ENV{PERL_HTTP_TINY_SSL_INSECURE_BY_DEFAULT}to1. β οΈ Bestie, think real hard before you touch that one β insecure-by-default is literally in the variable name, iykyk.
Verification is done by checking that that the TLS/SSL connection has a valid certificate corresponding to the host name of the connection and that the certificate has been verified by a CA. Assuming you trust the CA, this will protect against machine-in-the-middle attacks <http://en.wikipedia.org/wiki/Machine-in-the-middle_attack>.
Certificate verification requires a file or directory containing trusted CA certificates.
IO::Socket::SSL::default_ca() is called to detect the default location of your CA certificates. This also supports the environment variables SSL_CERT_FILE and SSL_CERT_DIR, and will fail over to Mozilla::CA if no certs are found. π
If IO::Socket::SSL::default_ca() is not able to find usable CA certificates, HTTP::Tiny will search several well-known system-specific default locations for a CA certificate file as a last resort:
/etc/ssl/certs/ca-certificates.crt/etc/pki/tls/certs/ca-bundle.crt/etc/ssl/ca-bundle.pem/etc/openssl/certs/ca-certificates.crt/etc/ssl/cert.pem/usr/local/share/certs/ca-root-nss.crt/etc/pki/tls/cacert.pem/etc/certs/ca-certificates.crt
An error will be occur if verify_SSL is true and no CA certificate file is available. π (yes, the original says "will be occur" and we are respectfully preserving the icon's exact energy)
If you desire complete control over TLS/SSL connections, the SSL_options attribute lets you provide a hash reference that will be passed through to IO::Socket::SSL::start_SSL(), overriding any options set by HTTP::Tiny. For example, to provide your own trusted CA file:
SSL_options => {
SSL_ca_file => $file_path,
}
The SSL_options attribute could also be used for such things as providing a client certificate for authentication to a server or controlling the choice of cipher used for the TLS/SSL connection. See IO::Socket::SSL documentation for details. π
π PROXY SUPPORT
HTTP::Tiny can proxy both http and https requests. Only Basic proxy authorization is supported and it must be provided as part of the proxy URL: http://user:pass@proxy.example.com/.
HTTP::Tiny supports the following proxy environment variables:
http_proxyorHTTP_PROXYhttps_proxyorHTTPS_PROXYall_proxyorALL_PROXY
If the REQUEST_METHOD environment variable is set, then this might be a CGI process and HTTP_PROXY would be set from the Proxy: header, which is a security risk. If REQUEST_METHOD is set, HTTP_PROXY (the upper case variant only) is ignored, but CGI_HTTP_PROXY is considered instead. β οΈ Yeah, that's a whole security vibe check right there.
Tunnelling https over an http proxy using the CONNECT method is supported. If your proxy uses https itself, you can not tunnel https over it.
Be warned that proxying an https connection opens you to the risk of a man-in-the-middle attack by the proxy server. π Not to be dramatic but like... your proxy can literally read everything.
The no_proxy environment variable is supported in the format of a comma-separated list of domain extensions proxy should not be used for.
Proxy arguments passed to new will override their corresponding environment variables. π
π LIMITATIONS
HTTP::Tiny is conditionally compliant with the HTTP/1.1 specifications <http://www.w3.org/Protocols/>:
- "Message Syntax and Routing" [RFC7230]
- "Semantics and Content" [RFC7231]
- "Conditional Requests" [RFC7232]
- "Range Requests" [RFC7233]
- "Caching" [RFC7234]
- "Authentication" [RFC7235]
It attempts to meet all "MUST" requirements of the specification, but does not implement all "SHOULD" requirements. (Note: it was developed against the earlier RFC 2616 specification and may not yet meet the revised RFC 7230-7235 spec.) Additionally, HTTP::Tiny supports the PATCH method of RFC 5789. β¨
Some particular limitations of note include:
- HTTP::Tiny focuses on correct transport. Users are responsible for ensuring that user-defined headers and content are compliant with the HTTP/1.1 specification.
- Users must ensure that URLs are properly escaped for unsafe characters and that international domain names are properly encoded to ASCII. See URI::Escape, URI::_punycode and Net::IDN::Encode.
- Redirection is very strict against the specification. Redirection is only automatic for response codes
301,302,307and308if the request method is 'GET' or 'HEAD'. Response code303is always converted into a 'GET' redirection, as mandated by the specification. There is no automatic support for status305("Use proxy") redirections. - There is no provision for delaying a request body using an
Expectheader. Unexpected1XXresponses are silently ignored as per the specification. - Only 'chunked'
Transfer-Encodingis supported. - There is no support for a Request-URI of '*' for the 'OPTIONS' request.
- Headers mentioned in the RFCs and some other, well-known headers are generated with their canonical case. Other headers are sent in the case provided by the user. Except for control headers (which are sent first), headers are sent in arbitrary order.
Despite the limitations listed above, HTTP::Tiny is considered feature-complete. New feature requests should be directed to HTTP::Tiny::UA. π«Ά
π SEE ALSO
- HTTP::Tiny::UA β Higher level UA features for HTTP::Tiny
- HTTP::Thin β HTTP::Tiny wrapper with HTTP::Request/HTTP::Response compatibility
- HTTP::Tiny::Mech β Wrap WWW::Mechanize instance in HTTP::Tiny compatible interface
- IO::Socket::IP β Required for IPv6 support
- IO::Socket::SSL β Required for SSL support
- LWP::UserAgent β If HTTP::Tiny isn't enough for you, this is the "standard" way to do things
- Net::SSLeay β Required for SSL support
π«Ά SUPPORT
π Bugs / Feature Requests
Please report any bugs or feature requests through the issue tracker at <https://github.com/Perl-Toolchain-Gang/HTTP-Tiny/issues>. You will be notified automatically of any progress on your issue. β¨
π§ Source Code
This is open source software. The code repository is available for public review and contribution under the terms of the license.
<https://github.com/Perl-Toolchain-Gang/HTTP-Tiny>
git clone https://github.com/Perl-Toolchain-Gang/HTTP-Tiny.git
π AUTHORS
- Christian Hansen <chansen@cpan.org>
- David Golden <dagolden@cpan.org>
π CONTRIBUTORS π
okay so this is the full group chat of absolute legends who contributed to HTTP::Tiny β no cap, every single name and email is here, exactly as the original credits list them. give it up for the whole crew π«Άβ¨
Alan Gardner <gardner@pythian.com>Alessandro Ghedini <al3xbio@gmail.com>A. Sinan Unur <nanis@cpan.org>Brad Gilbert <bgills@cpan.org>brian m. carlson <sandals@crustytoothpaste.net>Chris Nehren <apeiron@cpan.org>Chris Weyl <cweyl@alumni.drew.edu>Claes Jakobsson <claes@surfar.nu>Clinton Gormley <clint@traveljury.com>Craig A. Berry <craigberry@mac.com>Dan <grinnz@gmail.com>David Golden <xdg@xdg.me>David Mitchell <davem@iabyn.com>Dean Pearce <pearce@pythian.com>Edward Zborowski <ed@rubensteintech.com>Felipe Gasper <felipe@felipegasper.com>Graham Knop <haarg@haarg.org>Greg Kennedy <kennedy.greg@gmail.com>James E Keenan <jkeenan@cpan.org>James Raspass <jraspass@gmail.com>Jeremy Mates <jmates@cpan.org>Jess Robinson <castaway@desert-island.me.uk>Karen Etheridge <ether@cpan.org>Lukas Eklund <leklund@gmail.com>Martin J. Evans <mjegh@ntlworld.com>Martin-Louis Bright <mlbright@gmail.com>Matthew Horsfall <wolfsage@gmail.com>Michael R. Davis <mrdvt92@users.noreply.github.com>Michael Stevens <michael.stevens@dianomi.com>Mike Doherty <doherty@cpan.org>Nicolas Rochelemagne <rochelemagne@cpanel.net>Olaf Alders <olaf@wundersolutions.com>Olivier MenguΓ© <dolmen@cpan.org>Petr PΓsaΕ <ppisar@redhat.com>Philippe Bruhat (BooK) <book@cpan.org>Rob Mueller <robm@fastmailteam.com>sanjay-cpu <snjkmr32@gmail.com>Serguei Trouchelle <stro@cpan.org>Shoichi Kaji <skaji@cpan.org>SkyMarshal <skymarshal1729@gmail.com>SΓΆren Kornetzki <soeren.kornetzki@delti.com>Steve Grazzini <steve.grazzini@grantstreet.com>Stig Palmquist <git@stig.io>Syohei YOSHIDA <syohex@gmail.com>Tatsuhiko Miyagawa <miyagawa@bulknews.net>Tom Hukins <tom@eborcom.com>Tony Cook <tony@develop-help.com>Xavier Guimard <yadd@debian.org>
π COPYRIGHT AND LICENSE π
the legal bits, word-for-word, because that's how licenses stay iconic:
This software is copyright (c) 2026 by Christian Hansen.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
and that's the whole page, bestie πΈπ
source says perl v5.42.0, dated 2026-06-08, and this is HTTP::Tiny(3) β bye, ily, go write some tiny HTTP requests π¦β¨
π¦ where this page comes from
- opensuse-leap 16.0: perl-HTTP-Tiny 0.096-bp160.1.1 Β· Artistic-1.0 OR GPL-1.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms