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!

Data Management Digest – December 2025

Welcome to the December edition of Data Management Digest! As we continue our journey of data innovation, the ...

Index This | What is broken 80% of the time by February?

December 2025 Edition   Hayyy Splunk Education Enthusiasts and the Eternally Curious!    We’re back with this ...

Unlock Faster Time-to-Value on Edge and Ingest Processor with New SPL2 Pipeline ...

Hello Splunk Community,   We're thrilled to share an exciting update that will help you manage your data more ...