Dashboards & Visualizations

How to list & query macros for definitions using the Splunk Javascript SDK?

afgibson84
New Member

Does anyone know how to query macros using the Javascript SDK? I would like to essentially have the app list and/or query the macros.conf files so that I can dynamically pull in macro names and definitions.

0 Karma
1 Solution

renjith_nair
Legend

Hi @afgibson84,

try below,

var service = new splunkjs.Service({username: "admin", password: "yourpassword"});
var definition= service.get('properties/macros/"your macro name" /definition')["body"]
---
What goes around comes around. If it helps, hit it with Karma 🙂

View solution in original post

woodcock
Esteemed Legend

It often helps to see how Splunk itself does this. You can logon to your Search Head and run this command (and you can snoop on other aspects with debug tools of your browser):

|rest/servicesNS/-/-/configs/conf-macros splunk_server=local | dedup id | table eai:acl.owner eai:acl.sharing disabled title definition validation errormsg | rename eai:acl.* AS * | sort 0 title
0 Karma

renjith_nair
Legend

Hi @afgibson84,

try below,

var service = new splunkjs.Service({username: "admin", password: "yourpassword"});
var definition= service.get('properties/macros/"your macro name" /definition')["body"]
---
What goes around comes around. If it helps, hit it with Karma 🙂

felipesewaybric
Contributor

The answer above works for me.

0 Karma

vidhyaArumalla
Path Finder

This works

0 Karma

renjith_nair
Legend

@felipesewaybricker , @vidhyaArumalla . Glad to hear 🙂 you could upvote and accept it as an answer

---
What goes around comes around. If it helps, hit it with Karma 🙂
0 Karma

Anam
Community Manager
Community Manager

Hi @afgibson84

Please go ahead and accept the answer if the solution worked for you. If not, can you post more information on your query?

Thanks

0 Karma

afgibson84
New Member

Thank you - the answer above helped get me started but service.get() returned a promise. Here is what worked for me (using an already authenticated session):

var http = new splunkjs.SplunkWebHttp();
var service = new splunkjs.Service(http);
service.get('propertiec/macros/<name>/definition')
    .then((definition) => {
        console.log('here is the definition:',definition);
    });
0 Karma
Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

SOC4Kafka - New Kafka Connector Powered by OpenTelemetry

The new SOC4Kafka connector, built on OpenTelemetry, enables the collection of Kafka messages and forwards ...

Event Series: Level up your SOC: Advancing with Splunk Enterprise Security

AI has fundamentally raised the stakes for security operations, and this three-part series is your guide to ...

Announcing Modern Navigation: A New Era of Splunk User Experience

We are excited to introduce the Modern Navigation feature in the Splunk Platform, available to both cloud and ...