Splunk® Answers and Splunkbase

Splunk Apps Entitlement API Reference

Download manual as PDF

Download topic as PDF

Create or update 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.

Create an entitlement

POST /api/entitlements/

With a generic XML document such as this in the request body:

<?xml version="1.0" encoding="UTF-8"?>
<entitlement>
    <addon_id>678</addon_id>
    <username>testuser</username>
    <transaction_note>INVOICE:123_ABC-XYZ</transaction_note>
</entitlement>

Splunkbase extracts the xpaths /entitlement/addon_id, /entitlement/username, and /entitlement/transaction_note as the app_id, username, and transaction_note fields. On successful creation, Splunkbase returns a 303, redirecting to the URI at which the new entitlement can be retrieved.

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

Update an entitlement

POST /api/entitlements/APP_ID/latest/USERNAME

With a generic XML document such as this in the request body:

<?xml version="1.0" encoding="UTF-8"?>
<entitlement>
    <addon_id>678</addon_id>
    <username>testuser</username>
    <transaction_note>INVOICE:123_ABC-XYZ</transaction_note>
</entitlement>

This record must match the specified API end point for app_id and username. The transaction_note is written to the database and the last_update_time is updated. Updating an existing entitlement results in an HTTP 200 OK upon success.

Note: Only app owner/app editor/Splunkbase entitlement admin accountscan update an entitlement for a given app.

PREVIOUS
List entitlements
  NEXT
Delete 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