Splunk® Answers and Splunkbase

Splunk Apps Entitlement API Reference

Download manual as PDF

Download topic as PDF

List entitlements

The URI for the Splunkbase Entitlement API is: http://splunkbase.com/<endpoint>

Finding the APP_ID

To determine the APP_ID for your app, log into Splunkbase, navigate to the app, scroll to the bottom of the listing, click Edit and locate the App Primary Key on the resultant page. This is the value to use for APP_ID.

By application

GET /api/entitlements:byappid/APP_ID

This returns an XML Atom feed containing entitlement records.

Note: Only app owner/app editor/Splunkbase entitlement admin accounts can list entitlements for a given app.

By user

GET /api/entitlements:byusername/USERNAME

Note: Only a user or Splunkbase entitlement admin can list entitlements that belong to a user.

By transaction note (search/match)

GET /api/entitlements:bytransactionnote/TRANSACTION_SEARCH_TEXT

The TRANSACTION_SEARCH_TEXT must be 3 or more characters.

All entitlements are searched, but only entitlements that the app owner/app editor/Splunkbase entitlement admin would otherwise see in a "byapp" listing are returned.

Find a specific entitlement

GET /api/entitlements/APP_ID/latest/USERNAME

Splunkbase returns a feed with a single entitlement entry:

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:s="http://dev.splunk.com/ns/rest">
  <title>Splunkbase Entitlements</title>
  <updated>2011-12-22T07:12:14+00:00</updated>
  <id>/api/entitlements/263/latest/</id>
  <entry>
    <title>Splunkbase Entitlement</title>
    <updated>2011-12-22T07:12:14+00:00</updated>
    <id>/api/entitlements/263/latest/bgrantham_test</id>
    <content type="text/xml">
      <s:dict>
        <s:key name="username">bgrantham_test</s:key>
        <s:key name="addon_id">263</s:key>
        <s:key name="addon_name">Splunk Enterprise Security Suite</s:key>
        <s:key name="grantor_username">bgrantham_test</s:key>
        <s:key name="grantor_ipaddr">10.1.5.179</s:key>
        <s:key name="transaction_note">INVOICE:123_ABC_XYZ</s:key>
      </s:dict>
    </content>
  </entry>
</feed>

List multiple entitlements

The only actions available for multiple entitlements are listing (HTTP GET). An entitlement list is returned as an XML Atom feed with an "entries" tag containing entitlement records:

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:s="http://dev.splunk.com/ns/rest">
  <title>Splunkbase Entitlements for Splunk Enterprise Security Suite (263)</title>
  <updated>2011-12-22T06:59:50+00:00</updated>
  <id>/api/entitlements:byappid/263</id>
  <entry>
    <title>Splunkbase Entitlement</title>
    <updated>2011-12-22T06:58:10+00:00</updated>
    <id>/api/entitlements/263/latest/bgrantham_test</id>
    <content type="text/xml">
      <s:dict>
        <s:key name="username">bgrantham_test</s:key>
        <s:key name="addon_id">263</s:key>
        <s:key name="addon_name">Splunk Enterprise Security Suite</s:key>
        <s:key name="grantor_username">bgrantham_test</s:key>
        <s:key name="grantor_ipaddr">10.1.5.179</s:key>
        <s:key name="transaction_note">INVOICE:123_ABC_XYZ</s:key>
      </s:dict>
    </content>
  </entry>
  <entry>
    <title>Splunkbase Entitlement</title>
    <updated>2011-12-22T06:59:50+00:00</updated>
    <id>/api/entitlements/263/latest/bgrantham_splunk</id>
    <content type="text/xml">
      <s:dict>
        <s:key name="username">bgrantham_splunk</s:key>
        <s:key name="addon_id">263</s:key>
        <s:key name="addon_name">Splunk Enterprise Security Suite</s:key>
        <s:key name="grantor_username">bgrantham_test</s:key>
        <s:key name="grantor_ipaddr">10.1.5.179</s:key>
        <s:key name="transaction_note">INVOICE:567_MNO</s:key>
      </s:dict>
    </content>
  </entry>
</feed>
PREVIOUS
What's an entitlement?
  NEXT
Create or update entitlements

This documentation applies to the following versions of Splunk® Answers and Splunkbase: splunkbase


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters