strange error trying to set up a simple setup.xml example


I'm encountering some difficulties trying to get setup.xml working reliably across multiple apps.

When I take a step back and follow the simpler instructions that involve no custom rest endpoint:

I hit a weird message when the form is submitted. Here's my endpoint and my entity. I'm just writing a single macro.

<block title="My Block Title" endpoint="admin/macros" entity="my_macro_name">
  <input field="definition">

The setup.xml does load correctly, but submitting the form gives:

Encountered the following error while trying to update: In handler 'localapps': Argument &quot;disabled&quot; is not supported by this handler.

(the quote characters do indeed appear escaped like that, in case anyone's wondering.)

Can anyone shed any light on what the error message is talking about?

Tags (1)

Splunk Employee
Splunk Employee

Yes, the bug has been there as long as the macros endpoint has been around. Yes, we're working on fixing this bug for macros and any other endpoints. Unfortunately, the only workaround right now is to use a custom REST handler.

0 Karma


I'm encountering this bug too with a simple admin/transforms-extract setup block. Any workarounds? I think I'll try writing my own REST handler.

0 Karma

Splunk Employee
Splunk Employee

First off, clearly this is a bug. In order to understand the message you'd have to first understand what the setup REST handles does when the user saves the setup content. It

  1. gets the entity (in strict mode) that you're trying to edit via setup,
  2. it changes the fields specified in setup.xml with the values provided by the user
  3. submits the values to the target handler (admin/macros in this case)

Strict mode is a way to list entities with only the fields that are supported on edit/create and disabled field - the reason for listing disabled in strict mode is for the caller to determine the state of the entity. So, the bug here is with the macros REST endpoint not supporting disabled when editing/creating.


I have a feeling this bug has been here for a while. Has anyone been working on it? Is it just macros? Any idea what other endpoints/entities will not work in setup.xml? I went back to having setup.xml post to a custom python endpoint, but sometimes I dont really want to maintain all those extra moving parts...

0 Karma
State of Splunk Careers

Access the Splunk Careers Report to see real data that shows how Splunk mastery increases your value and job satisfaction.

Find out what your skills are worth!