Splunk Search

Multiple ways to access lookup transforms via REST, which should I use?

LukeMurphey
Champion

There are multiple ways to access lookup transforms via REST, including:

  1. data/transforms/lookups
  2. configs/conf-transforms
  3. properties/transforms/

Which one should I be using?

0 Karma
1 Solution

LukeMurphey
Champion

Here is when you ought to use each endpoint:

  1. If performing a write, use data/transforms/lookups
  2. If performing a read and you need fields_list, use data/transforms/lookups
  3. For everything else, use configs/conf-transforms

Generally, it is recommended that you avoid using data/transforms/lookups/ since this endpoint triggers some activity that can cause some unnecessary performance reduction and will generate a substantial number of log messages in the internal index.

If you need to access ACL information (i.e. namespace and owner) then you will need to use configs/conf-transforms since properties/transforms/ won't include it.

View solution in original post

LukeMurphey
Champion

Here is when you ought to use each endpoint:

  1. If performing a write, use data/transforms/lookups
  2. If performing a read and you need fields_list, use data/transforms/lookups
  3. For everything else, use configs/conf-transforms

Generally, it is recommended that you avoid using data/transforms/lookups/ since this endpoint triggers some activity that can cause some unnecessary performance reduction and will generate a substantial number of log messages in the internal index.

If you need to access ACL information (i.e. namespace and owner) then you will need to use configs/conf-transforms since properties/transforms/ won't include it.

hazekamp
Builder

We recommend the following GET arguments when pinpointing lookups using configs/conf-transforms. This is because transforms.conf houses all manner of properties.

getargs = {'output_mode': 'json', 'count': 0, 'search': 'filename=* OR collection=* OR external_type=*'}

Of course, if you're targeting a specific transform by name, this is not needed.

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!

Quantify Your Splunk Investment Impact: Introducing Savings Metrics to Value Insights

Building on the foundation established in our initial Value Insights releases, we are introducing the Savings ...

Event Series: Telemetry Pipeline Management

Balancing Scale and Spend: Gaining Control Over High-Volume Metrics in Splunk Observability Cloud As ...

Kick the Tires Before You Commit: A Hands-On Tour of the Splunk Observability Cloud ...

Evaluating an enterprise observability platform usually goes like this: fill out a form, get a free trial with ...