WWW::Splunk::API(3pm)

💖 WWW::Splunk::API 💖

okay bestie, gather round, because we're talking about WWW::Splunk::API — a perl manual page, section 3pm, from the User Contributed Perl Documentation collection. it's giving infrastructure, it's giving main character energy, and honestly? it slays. 🌈

---

✨ NAME ✨

WWW::Splunk::API — your literal Splunk REST client. that's the whole name, no cap. 💅

---

🦋 DESCRIPTION 🦋

so WWW::Splunk::API is a low-level interface to the Splunk log search engine. it's the one handling all the HTTP communication for you, and it also does the unglamorous work of working around certain interface glitches so you don't have to cry about them. 🫶

if you want the actual API definition, it lives here:

<https://www.splunk.com/base/Documentation/latest/Developer/RESTSearch>

(that's the link, exactly as the page gives it: <http://www.splunk.com/base/Documentation/latest/Developer/RESTSearch>)

and here's the iconic part: this module is designed to be Splunk API version agnostic. she does not pick favorites. she works with all of them. periodt. 👑

---

🌸 new (params) 🌸

a constructor, babes. you make a Splunk object like this:

my $splunk = WWW::Splunk::API->new({
        host => $host,
        port => $port,
        login => $login,
        password => $password,
        unsafe_ssl => 0,
        verbose => 0,
});

and the default values are, in order:

• port — 8089
• host — localhost
• url — https://$host:$port
• verbose — 0
• unsafe_ssl — 0
• service_prefix — /services
• search — 1

like, if you don't pass any of these, that's what you get. no surprises. we love a predictable queen. 💖

---

🎀 delete (parameters) 🎀

a cute lil wrapper around HTTP::Request::Common::DELETE(). that's it, that's the whole vibe. 🗑️

---

🌟 post (parameters) 🌟

wrapper around HTTP::Request::Common::POST(). sending it. 💌

---

🦄 get (parameters) 🦄

wrapper around HTTP::Request::Common::GET(). fetching the tea. ☕

---

💫 head (parameters) 💫

wrapper around HTTP::Request::Common::HEAD(). and heads up: it's not used anywhere in splunk API. she's just sitting there, existing, being iconic for no reason. 🙈

---

🍓 put (parameters) 🍓

wrapper around HTTP::Request::Common::PUT(). and yeah — same situation, this one is not used anywhere in splunk API either. two for two. 💀

---

🌈 request (method, location, [data], [callback]) 🌈

the big one. this requests a Splunk api and deals with the results for you. 🫡

Method can be either:

• an HTTP::Request instance — peep HTTP::Request::Common for useful ones — or
• a plain string, such as "GET" or "DELETE."

the optional data is a hash reference, and it gets serialized into a request body for a POST request. and listen: use undef in case you don't have any data to send, but you still need to specify a callback function in the subsequent argument. iykyk. ✨

the call-back function can be specified for a single special case, where a XML stream of <results> elements is expected. that's the one and only scenario, bestie. 🎯

---

👀 SEE ALSO 👀

• WWW::Splunk
• sc

---

💜 AUTHORS 💜

the legends themselves:

• Lubomir Rintel, <lkundrak@v3.sk>
• Michal Josef Špaček <skim@cpan.org>

and the code is hosted on GitHub — <http://github.com/michal-josef-spacek/perl-WWW-Splunk> — where bug fixes and feature enhancements are always welcome. come thru, contributors, we're rooting for you fr fr. 🫶

---

📜 LICENSE 📜

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. iconic behavior. 💖

---

so yeah, that's the whole page, and it came from perl version v5.42.0, dated 2025-07-25, from the WWW::Splunk::API(3pm) manual. slay, go search some logs, drink water, and remember: your HTTP communication is handled. 🌸💅✨