Getting Data In

Setting tag values through REST API

spbayer
Engager

Is it possible create tags and set tag values through the REST API?

Tags (2)

Ledion_Bitincka
Splunk Employee
Splunk Employee

Yes it is possible, this not publicly documented however this is how the UI adds/deletes fields from the search view

POST /servicesNS/<user>/<app>/search/fields/<field-name>/tags "value=ValueToTagHere&add=tag1&add=tag2&delete=tag3&delete=tag4"

You can have as many add and delete tags as you wish in your POST

asdfasdf12321
Explorer

It's also possible to remove tags more globally with something like:

curl -u admin:changeme -k https://localhost:8089/servicesNS/admin/<app>/search/tags/<tag-name>; -d "delete"

Or the curl equivient of the above answer is:

curl -u admin:changeme -k https://localhost:8089/servicesNS/admin/<app>/search/fields/<field-name>/tags  -d"value=ValueToTagHere&add=tag1&add=tag2&delete=tag3&delete=tag4"
0 Karma

asdfasdf12321
Explorer

The tagger app appears to use this undocumented API.

0 Karma

ma_anand1984
Contributor

@Ledion Bitincka
I dont understand, we usually access tags like | rest splunk_server=local /servicesNS/-/-/search/fields/{field name}/tags

how to user POST is it like "| POST "or "| rest POST". Can you give full command?

0 Karma

gkanapathy
Splunk Employee
Splunk Employee

It is theoretically possible. In general, anything you can do via the UI can be done via the REST API, since the UI uses the REST API to do all Splunk server and object manipulations. However, in practice, not all object manipulations are currently published.

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!

Mile High Learning with Splunk University, Denver, Colorado

If Denver is known for its mile-high elevation, Splunk University is about to raise the bar on technical ...

IT Service Intelligence 5.0 Series: Your Guide to the June Launch

We are excited to announce the June release of Splunk IT Service Intelligence (ITSI) 5.0. This update ...

Agent Mode Engaged! Enchaining Agentic Operations with Splunk AI Assistant 2.0

    Are you ready to transform how your team handles complex data requests? We invite you to our upcoming ...