SplunkBase API

Use the SplunkBase API to directly interact with SplunkBase, bypassing the SplunkBase Web UI. The SplunkBase API is located at https://splunkbase.com/API/.

Apps

The https://splunkbase.com/API/apps/ endpoint provides top level links into the apps API.

GET

Returns an Atom feed of links.

Response

Response	Status
200	OK

Response Body

// sample response to /api/apps

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>SplunkBase Applications</title>
  <link href="http://www.splunkbase.com/api/apps"/>
  <updated>2008-02-14T22:38:17+00:00</updated>
  <id>http://www.splunkbase.com/api/apps</id>
  <entry>
    <title>All Applications</title>

    <updated>2008-02-14T22:38:17+00:00</updated>
    <id>http://www.splunkbase.com/api/apps/entries</id>
    <link href="http://www.splunkbase.com/api/apps/entries" rel="alternate"/>
  </entry>
  <entry>
    <title>Categories</title>
    <updated>2008-02-14T22:38:17+00:00</updated>

    <id>http://www.splunkbase.com/api/apps/categories</id>
    <link href="http://www.splunkbase.com/api/apps/categories" rel="alternate"/>
  </entry>
  <entry>
    <title>Types</title>
    <updated>2008-02-14T22:38:17+00:00</updated>
    <id>http://www.splunkbase.com/api/apps/types</id>

    <link href="http://www.splunkbase.com/api/apps/types" rel="alternate"/>
  </entry>
</feed>

Types

The https://splunkbase.com/api/apps/types/ endpoint provides a list of Application types defined on SplunkBase.

GET

Returns an Atom feed of type names that can be used with /api/apps/entries

Response

Response	Status
200	OK

Response Body

// sample response to /api/apps/types

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>SplunkBase Application Types</title>
  <link href="http://www.splunkbase.com/api/apps/types"/>
  <updated>2008-02-14T22:43:33+00:00</updated>
  <id>http://www.splunkbase.com/api/apps/types</id>
  <entry>
    <title>Alerts</title>

    <updated>2008-02-14T22:43:33+00:00</updated>
    <id>http://www.splunkbase.com/apps/Alerts</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?type=Alerts" rel="related"/>
  </entry>
  <entry>
    <title>Clients</title>
    <updated>2008-02-14T22:43:33+00:00</updated>

    <id>http://www.splunkbase.com/apps/Clients</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?type=Clients" rel="related"/>
  </entry>
  <entry>
    <title>Custom Processing</title>
    <updated>2008-02-14T22:43:33+00:00</updated>
    <id>http://www.splunkbase.com/apps/Custom_Processing</id>

    <link href="http://www.splunkbase.com/api/apps/entries/?type=Custom_Processing" rel="related"/>
  </entry>
  <entry>
    <title>Event Actions</title>
    <updated>2008-02-14T22:43:33+00:00</updated>
    <id>http://www.splunkbase.com/apps/Event_Actions</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?type=Event_Actions" rel="related"/>

  </entry>
  <entry>
    <title>Event Types</title>
    <updated>2008-02-14T22:43:33+00:00</updated>
    <id>http://www.splunkbase.com/apps/Event_Types</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?type=Event_Types" rel="related"/>
  </entry>

  <entry>
    <title>Fields</title>
    <updated>2008-02-14T22:43:33+00:00</updated>
    <id>http://www.splunkbase.com/apps/Fields</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?type=Fields" rel="related"/>
  </entry>
</feed>

Category Path

The https://splunkbase.com/api/apps/categories/category_path endpoint provides a list of Application categories defined on SplunkBase.

GET

Returns an Atom feed of category names. If category_path is omitted then the top level list of categories is returned. Each category has a link to an alternate view to return its children.

Response

Response	Status
200	OK
404	Invalid category name

Response Body

// sample response to /api/apps/categories

<?xml version="1.0" encoding="utf-8"?>

<feed xmlns="http://www.w3.org/2005/Atom">
  <title>SplunkBase Application Categories: Top Level</title>
  <link href="http://www.splunkbase.com/api/apps/categories/"/>
  <updated>2008-02-14T22:56:01+00:00</updated>
  <id>http://www.splunkbase.com/api/apps/categories/</id>
  <entry>

    <title>Applications</title>

    <updated>2008-02-14T22:56:01+00:00</updated>
    <id>http://www.splunkbase.com/apps/categories/Applications</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?category=Applications" rel="related"/>
    <link href="http://www.splunkbase.com/api/apps/categories/Applications" rel="alternate"/>
    <count>1</count>
  </entry>
  <entry>

    <title>Availability</title>
    <updated>2008-02-14T22:56:01+00:00</updated>
    <id>http://www.splunkbase.com/apps/categories/Availability</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?category=Availability" rel="related"/>
    <link href="http://www.splunkbase.com/api/apps/categories/Availability" rel="alternate"/>
    <count>0</count>
  </entry>

  <entry>
    <title>Business Intelligence</title>
    <updated>2008-02-14T22:56:01+00:00</updated>
    <id>http://www.splunkbase.com/apps/categories/Business_Intelligence</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?category=Business_Intelligence" rel="related"/>
    <link href="http://www.splunkbase.com/api/apps/categories/Business_Intelligence" rel="alternate"/>
    <count>0</count>

  </entry>
  <entry>
    <title>Compliance</title>
    <updated>2008-02-14T22:56:01+00:00</updated>
    <id>http://www.splunkbase.com/apps/categories/Compliance</id>
    <link href="http://www.splunkbase.com/api/apps/entries/?category=Compliance" rel="related"/>
    <link href="http://www.splunkbase.com/api/apps/categories/Compliance" rel="alternate"/>

    <count>0</count>
  </entry>
</feed>

Entries

The https://splunkbase.com/api/apps/entries endpoint provides a filtered list of applications matching an optional specification.

+++GET
Returns the filtered list.

Form	Arguments
category	An encoded category name to filter on.
type	An encoded name to filter on.
q	String to match anywhere in an application title or short description.
name	Name of an application (exact match) - May be repeated to match multiple applications.
sort	Result sort order - Only 'latest' (default) is currently supported.
offset	An integer offset to start from (default 0).
count	Integer maximum number of results to return.

Response

Response	Status
200	OK

Response Body

// sample response to /api/apps/entries
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>SplunkBase Applications</title>
  <link href="http://www.splunkbase.com/api/apps/entries"/>
  <link href="http://www.splunkbase.com/api/apps/entries?offset=10&count=10" rel="next"/>
  <updated>2008-02-14T23:25:21+00:00</updated>
  <id>http://www.splunkbase.com/api/apps/entries?&offset=0&count=10</id>

  <entry>
    <title>Complete Windows Security Log Event Types v. 2</title>
    <updated>2007-11-18T06:34:31+00:00</updated>
    <id>http://www.splunkbase.com/api/apps/entries/Complete+Windows+Security+Log+Event+Types+v.+2</id>
    <link href="http://www.splunkbase.com/api/apps/entries/Complete+Windows+Security+Log+Event+Types+v.+2" rel="alternate"/>
    <author>
      <name>tbird</name>

    </author>
    <summary>Splunk event types for the Windows events described in the HOWTO on understanding the Microsoft Event Log</summary>
  </entry>
  <entry>
    <title>Alex's sendemail.py</title>
    <updated>2007-11-16T21:52:33+00:00</updated>
    <id>http://www.splunkbase.com/api/apps/entries/Alex%27s+sendemail.py</id>

    <link href="http://www.splunkbase.com/api/apps/entries/Alex%27s+sendemail.py" rel="alternate"/>
    <author>
      <name>araitz</name>
    </author>
    <summary>A modified version of sendemail.py which allows you to configure which fields are displayed in alert emails.</summary>
  </entry>
  <entry>
    <title>WebLogic Event Types</title>

    <updated>2007-11-06T23:24:42+00:00</updated>
    <id>http://www.splunkbase.com/api/apps/entries/WebLogic+Event+Types</id>
    <link href="http://www.splunkbase.com/api/apps/entries/WebLogic+Event+Types" rel="alternate"/>
    <author>
      <name>SplunkAddons</name>
    </author>
    <summary>Field Extractions and Event Types that match events coming from WebLogic 9.2 and WebLogic 10.0.</summary>

  </entry>
</feed>

App Name

The https://splunkbase/api/apps/entries/app_name endpoint provides data on a specific application.

GET

Returns application information, along with a list of architecture, version and filename triplets.

Response

Response	Status
200	OK
404	Application name not found.

Response Body

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>Alex's sendemail.py</title>
  <updated>2007-11-16T21:52:33+00:00</updated>
  <id>http://www.splunkbase.com/Alex%27s+sendemail.py</id>
  <author>
    <name>araitz</name>
  </author>

  <category term="Alerts_%26_reports" label="Alerts & reports"/>
  <summary>A modified version of sendemail.py which allows you to configure which fields are displayed in alert emails.</summary>
  <entry>
    <title>Version: Latest, Architecture: Any, File: sendemail.tar.gz</title>
    <updated>2007-11-16T21:52:33+00:00</updated>
    <id>http://www.splunkbase.com/apps/Alex%27s+sendemail.py/latest/all</id>
    <link href="http://www.splunkbase.com/apps/Alex%27s+sendemail.py/latest/download" rel="download" type="application/x-gzip"/>

    <architecture>Any</architecture>
    <version>Latest</version>
  </entry>
</feed>

Previous: Applications Endpoint | Next: Legacy methods

Comments

No comments have been submitted.