Splunk® Answers and Splunkbase

Splunk Apps Entitlement API Reference

Download manual as PDF

Download topic as PDF

What's an entitlement?

An entitlement consists of a user-to-app mapping and an all-purpose transaction note field for storing client-specific text data.

In communications between clients and Splunkbase, an entitlement record can contain:

  • username: the splunk.com login of the the entitlement grantee
  • addon_id: the primary key of the app in Splunkbase
  • addon_name (only on retrieval): the name of the app in Splunkbase (this is provided for convenience in reading records)
  • grantor_username: the splunk.com login that was used to grant the entitlement
  • grantor_ipaddr: the IPv4 address of the client that was used to grant the entitlement
  • transaction_note: a free field for clients to use to store data relevant to the entitlement (invoice #, transaction ID, etc.). Up to 1024 characters
  • create_time (read-only): the UNIX timestamp from when the entitlement was created
  • last_update_time (read-only): the UNIX timestamp from when the entitlement was last updated (or created if never updated)

To create an entitlement in Splunkbase you must provide an app_id, a username, and optionally a transaction_note.

Entitlements are granted on a per-app basis. Granting entitlements on specific app versions is not currently supported, but has been accounted for in the API and will be supported in the future.

When retrieved, an entitlement will always have username, addon_id, addon_name, create_time, and last_update_time fields. If the splunk.com account that the HTTP client uses to connect is the owner, or otherwise has editing permissions on the app (such as SB admins), the grantor_username, grantor_ipaddr, and transaction_note are included.

The only field in an entitlement that can be updated by a client is the transaction_note (the last_update_time field will update automatically). To update an entitlement, you must provide the app_id and username of an extant entitlement , as well as a new transaction_note.

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.

What is supported by this API
List 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