Splunk Dev

Can the .spec be retrieved via REST

abramble
Explorer

Similar to fetching config by namespace via REST - Configuration Endpoints, is there a way to access the .spec defined for different config files via REST API?

Edit: spelling.

Labels (1)
0 Karma
1 Solution

abramble
Explorer

Answering my own question. After digging around I discovered in the default restmap.conf a reference to

[spec:spec]
match=/configs/spec

What appears to be merged spec from all apps is available, however I cannot find any documentation of the input params. "filename" and "stanza" I was able to guess.

/services/config/spec?filename=alert_actions

{
  "filename": "alert_actions",
  "stanzas": [
    {
      "stanza": "default",
      "rawStanza": "default"
    },
    {
      "stanza": "email",
      "rawStanza": "email"
    },
    {
      "stanza": "logevent",
      "rawStanza": "logevent"
    },
    {
      "stanza": "lookup",
      "rawStanza": "lookup"
    },
    {
      "stanza": "outputtelemetry",
      "rawStanza": "outputtelemetry"
    },
    {
      "stanza": "populate_lookup",
      "rawStanza": "populate_lookup"
    },
    {
      "stanza": "rss",
      "rawStanza": "rss"
    },
    {
      "stanza": "script",
      "rawStanza": "script"
    },
    {
      "stanza": "summary_index",
      "rawStanza": "summary_index"
    },
    {
      "stanza": "webhook",
      "rawStanza": "webhook"
    }
  ]
}


and deeper inspection by passing the 'stanza' parameter

/services/configs/spec?filename=alert_actions&stanza=email

{
  "filename": "alert_actions",
  "stanza": "email",
  "settings": [
    {
      "name": "alert.execute.cmd",
      "placeholder": "<string>"
    },
    {
      "name": "alert.execute.cmd.arg.<n>",
      "placeholder": "<string>"
    },
    {
      "name": "auth_password",
      "placeholder": "<password>"
    }
  ]
  ... elided
}

 

View solution in original post

Tags (1)
0 Karma

abramble
Explorer

Answering my own question. After digging around I discovered in the default restmap.conf a reference to

[spec:spec]
match=/configs/spec

What appears to be merged spec from all apps is available, however I cannot find any documentation of the input params. "filename" and "stanza" I was able to guess.

/services/config/spec?filename=alert_actions

{
  "filename": "alert_actions",
  "stanzas": [
    {
      "stanza": "default",
      "rawStanza": "default"
    },
    {
      "stanza": "email",
      "rawStanza": "email"
    },
    {
      "stanza": "logevent",
      "rawStanza": "logevent"
    },
    {
      "stanza": "lookup",
      "rawStanza": "lookup"
    },
    {
      "stanza": "outputtelemetry",
      "rawStanza": "outputtelemetry"
    },
    {
      "stanza": "populate_lookup",
      "rawStanza": "populate_lookup"
    },
    {
      "stanza": "rss",
      "rawStanza": "rss"
    },
    {
      "stanza": "script",
      "rawStanza": "script"
    },
    {
      "stanza": "summary_index",
      "rawStanza": "summary_index"
    },
    {
      "stanza": "webhook",
      "rawStanza": "webhook"
    }
  ]
}


and deeper inspection by passing the 'stanza' parameter

/services/configs/spec?filename=alert_actions&stanza=email

{
  "filename": "alert_actions",
  "stanza": "email",
  "settings": [
    {
      "name": "alert.execute.cmd",
      "placeholder": "<string>"
    },
    {
      "name": "alert.execute.cmd.arg.<n>",
      "placeholder": "<string>"
    },
    {
      "name": "auth_password",
      "placeholder": "<password>"
    }
  ]
  ... elided
}

 

Tags (1)
0 Karma
Get Updates on the Splunk Community!

SplunkTrust Application Period is Officially OPEN!

It's that time, folks! The application/nomination period for the 2025 SplunkTrust is officially open! If you ...

Splunk Answers Content Calendar, June Edition II

Get ready to dive into Splunk Dashboard panels this week! We'll be tackling common questions around ...

Splunk Observability Cloud's AI Assistant in Action Series: Auditing Compliance and ...

This is the third post in the Splunk Observability Cloud’s AI Assistant in Action series that digs into how to ...