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!

Manage Edge Processor pipelines end to end with APIs

This guide uses the Data Management APIs to create an Edge Processor, onboard one instance, deploy a pipeline ...

Splunk Brings Proof of Control to Digital Asset Transfers

Digital assets now sit inside the core of financial services. HSBC launched its Tokenized Deposit Service in ...

Manage Ingest Processor pipelines end to end with APIs

This guide uses the Data Management APIs to create an Ingest Processor pipeline, deploy it to the ...