Splunk® Enterprise

REST API Reference Manual

Download manual as PDF

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Licenses

Use the Licensing endpoints to manage licensing configurations.


licenser/groups

Provides access to the configuration of licenser groups.

A licenser group contains one or more licenser stacks that can operate concurrently. Only one licenser group is active at any given time

GET licenser/groups

Lists all licenser groups.

Request

Name Type Required Default Description
count Number 30 Indicates the maximum number of entries to return. To return all entries, specify 0.
offset Number 0 Index for first item to return.
search String Search expression to filter the response. The response matches field values against the search expression. For example:

search=foo matches any object that has "foo" as a substring in a field. search=field_name%3Dfield_value restricts the match to a single field. URI-encoding is required in this example.

sort_dir Enum asc Valid values: (asc | desc)

Indicates whether to sort returned entries in ascending or descending order.

sort_key String name Field to use for sorting.
sort_mode Enum auto Valid values: (auto | alpha | alpha_case | num)

Indicates the collating sequence for sorting the returned entries. auto: If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically. alpha: Collate alphabetically. alpha_case: Collate alphabetically, case-sensitive. num: Collate numerically.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenser groups.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
is_active Indicates if the license group is active.
stack_ids The license stacks in the license group.

Example

Lists all the licenser groups for this Splunnk instance.


curl -k -u admin:pass https://localhost:8089/services/licenser/groups


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:s="http://dev.splunk.com/ns/rest">
  <title>groups</title>
  <id>https://localhost:8089/services/licenser/groups</id>
  <updated>2011-07-11T09:45:35-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <!-- opensearch nodes elided for brevity. -->
  <s:messages/>
  <entry>
    <title>Enterprise</title>
    <id>https://localhost:8089/services/licenser/groups/Enterprise</id>
    <updated>2011-07-11T09:45:35-07:00</updated>
    <link href="/services/licenser/groups/Enterprise" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/groups/Enterprise" rel="list"/>
    <link href="/services/licenser/groups/Enterprise" rel="edit"/>
    <content type="text/xml">
      <s:dict>
        <!-- eai:acl nodes elided for brevity. -->
        <s:key name="is_active">1</s:key>
        <s:key name="stack_ids">
          <s:list>
            <s:item>enterprise</s:item>
          </s:list>
        </s:key>
      </s:dict>
    </content>
  </entry>
</feed>

licenser/groups/{name}

GET licenser/groups/{name}

Lists a specific licenser group. A licenser group contains one or more licenser stacks that can operate concurrently. Only one licenser group is active at any given time

Request

No parameters for this request.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenser groups.
404 Licenser groups does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
eai:attributes See Accessing Splunk resources
is_active Indicates if the license group is active.
stack_ids The license stacks in the license group.

Example

Return information about the Forwarder licenser group.


curl -k -u admin:pass https://localhost:8089/services/licenser/groups/Forwarder


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:s="http://dev.splunk.com/ns/rest">
  <title>groups</title>
  <id>https://localhost:8089/services/licenser/groups</id>
  <updated>2011-07-11T09:47:18-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <!-- opensearch nodes elided for brevity. -->
  <s:messages/>
  <entry>
    <title>Forwarder</title>
    <id>https://localhost:8089/services/licenser/groups/Forwarder</id>
    <updated>2011-07-11T09:47:18-07:00</updated>
    <link href="/services/licenser/groups/Forwarder" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/groups/Forwarder" rel="list"/>
    <link href="/services/licenser/groups/Forwarder" rel="edit"/>
    <content type="text/xml">
      <s:dict>
        <!-- eai:acl nodes elided for brevity. -->
        <s:key name="eai:attributes">
          <s:dict>
            <s:key name="optionalFields">
              <s:list/>
            </s:key>
            <s:key name="requiredFields">
              <s:list>
                <s:item>is_active</s:item>
              </s:list>
            </s:key>
            <s:key name="wildcardFields">
              <s:list/>
            </s:key>
          </s:dict>
        </s:key>
        <s:key name="is_active">0</s:key>
        <s:key name="stack_ids">
          <s:list>
            <s:item>forwarder</s:item>
          </s:list>
        </s:key>
      </s:dict>
    </content>
  </entry>
</feed>

POST licenser/groups/{name}

Activates specific licenser group with the side effect of deactivating the previously active one.

There can only be a single active licenser group for a given instance of Splunk. Use this to switch between, for example, free to enterprise, or download-trial to free.

Request

Name Type Required Default Description
is_active Boolean
Active specific licenser group

Response Codes

Status Code Description
200 Updated successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
402 The Splunk license in use has disabled this feature.
403 Insufficient permissions to edit licenser group.
404 Licenser group does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.
503 This feature has been disabled in Splunk configuration files.

Returned Values

No values returned for this request.

Example

Make the Enterprise licenser group the active license group.


curl -k -u admin:pass https://localhost:8089/services/licenser/groups/Enterprise \
	-d is_active=1


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:s="http://dev.splunk.com/ns/rest">
  <title>groups</title>
  <id>https://localhost:8089/services/licenser/groups</id>
  <updated>2011-07-11T09:55:02-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <!-- opensearch nodes elided for brevity. -->
  <s:messages/>
</feed>


licenser/licenses

Provides access to the licenses for this Splunk instance.

A license enables various features for a splunk instance, including but not limitted to indexing quota, auth, search, forwarding, and so forth.

GET licenser/licenses

Lists all licenses that have been added. Only a subset of these licenses may be active however, this is simply listing all licenses in every stack/group, regardless of which group is active

Request

Name Type Required Default Description
count Number 30 Indicates the maximum number of entries to return. To return all entries, specify 0.
offset Number 0 Index for first item to return.
search String Search expression to filter the response. The response matches field values against the search expression. For example:

search=foo matches any object that has "foo" as a substring in a field. search=field_name%3Dfield_value restricts the match to a single field. URI-encoding is required in this example.

sort_dir Enum asc Valid values: (asc | desc)

Indicates whether to sort returned entries in ascending or descending order.

sort_key String name Field to use for sorting.
sort_mode Enum auto Valid values: (auto | alpha | alpha_case | num)

Indicates the collating sequence for sorting the returned entries. auto: If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically. alpha: Collate alphabetically. alpha_case: Collate alphabetically, case-sensitive. num: Collate numerically.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenses.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
creation_time The creation time of this license, in Coordinated Universal Time (UTC).
expiration_time The time this license expires, in Coordinated Universal Time (UTC).
features The list of features and components enabled by this license.
group_id The ID of the group to which this license belongs.
label Plain text description of this license.
license_hash Unique identifier for the license.

The REST API uses this identifier to access this license.

max_violations The maximum number of violations allowed during the specified window period (window_period.

Searching is disabled when max_violations is exceeded.

quota Daily indexing quota, in bytes, for this license.
sourcetypes The list of allowed sourcetypes for this list. You cannot use this license to index sourcetypes that are not present in this list.

An empty list indicates all sourcetypes are allowed.

stack_id The ID of the license stack to which this license belongs.
status The status of a license can be either VALID or EXPIRED.
type Provides any additional information about the type of this license.
window_period The rolling period, in days, in which violations are aggregated.

Example

List information about all licenses for the Splunk instance.


curl -k -u admin:pass https://localhost:8089/services/licenser/licenses


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:s="http://dev.splunk.com/ns/rest">
  <title>licenses</title>
  <id>https://localhost:8089/services/licenser/licenses</id>
  <updated>2011-07-11T09:30:33-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/licenses/_new" rel="create"/>
  <!-- opensearch nodes elided for brevity. -->
  <s:messages/>
  <entry>
    <title>E08B . . . FA75BF</title>
    <id>https://localhost:8089/services/licenser/licenses/E08B . . . FA75BF</id>
    <updated>2011-07-11T09:30:33-07:00</updated>
    <link href="/services/licenser/licenses/E08B . . . FA75BF" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/licenses/E08B . . . FA75BF" rel="list"/>
    <link href="/services/licenser/licenses/E08B . . . FA75BF" rel="remove"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="creation_time">1309852804</s:key>
        <!-- eai:acl nodes elided for brevity. -->
        <s:key name="expiration_time">1315641604</s:key>
        <s:key name="features">
          <s:list>
            <s:item>Auth</s:item>
            <s:item>FwdData</s:item>
            <s:item>RcvData</s:item>
            <s:item>LocalSearch</s:item>
            <s:item>DistSearch</s:item>
            <s:item>RcvSearch</s:item>
            <s:item>ScheduledSearch</s:item>
            <s:item>Alerting</s:item>
            <s:item>DeployClient</s:item>
            <s:item>DeployServer</s:item>
            <s:item>SplunkWeb</s:item>
            <s:item>SigningProcessor</s:item>
            <s:item>SyslogOutputProcessor</s:item>
            <s:item>AllowDuplicateKeys</s:item>
          </s:list>
        </s:key>
        <s:key name="group_id">Trial</s:key>
        <s:key name="label">Splunk Enterprise Download Trial</s:key>
        <s:key name="license_hash">E08B . . . FA75BF</s:key>
        <s:key name="max_violations">5</s:key>
        <s:key name="quota">524288000</s:key>
        <s:key name="sourcetypes">
          <s:list/>
        </s:key>
        <s:key name="stack_id">download-trial</s:key>
        <s:key name="status">VALID</s:key>
        <s:key name="type">download-trial</s:key>
        <s:key name="window_period">30</s:key>
      </s:dict>
    </content>
  </entry>
</feed>

POST licenser/licenses

Add a license entitlement to this instance.

Request

Name Type Required Default Description
name string
Path to license file on server. If the payload parameter is specified, the name parameter is ignored.
payload string String representation of license, encoded in xml

Response Codes

Status Code Description
201 Created successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
402 The Splunk license in use has disabled this feature.
403 Insufficient permissions to add a license.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.
503 This feature has been disabled in Splunk configuration files.

Returned Values

Attribute Description
creation_time The creation time of this license, in Coordinated Universal Time (UTC).
expiration_time The time this license expires, in Coordinated Universal Time (UTC).
features The list of features and components enabled by this license.
group_id The ID of the group to which this license belongs.
label Plain text description of this license.
license_hash Unique identifier for the license.

The REST API uses this identifier to access this license.

max_violations The maximum number of violations allowed during the specified window period (window_period.

Searching is disabled when max_violations is exceeded.

payload String representation of license, encoded in xml.
quota Daily indexing quota, in bytes, for this license.
sourcetypes The list of allowed sourcetypes for this list. You cannot use this license to index sourcetypes that are not present in this list.

An empty list indicates all sourcetypes are allowed.

stack_id The ID of the license stack to which this license belongs.
status The status of a license can be either VALID or EXPIRED.
type Provides any additional information about the type of this license.
window_period The rolling period, in days, in which violations are aggregated.

Example

Adds a Splunk license entitlement from a downloaded Splunk license file.


curl -k -u admin:pass https://localhost:8089/services/licenser/licenses \
	-d name=/Users/vgenovese/downloads/Splunk_enterprise.lic


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:s="http://dev.splunk.com/ns/rest">
  <title>licenses</title>
  <id>https://localhost:8089/services/licenser/licenses</id>
  <updated>2011-07-11T09:41:32-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/licenses/_new" rel="create"/>
  <!-- opensearch nodes elided for brevity. -->
  <s:messages/>
  <entry>
    <title>CF6C50 . . . 72CE6C</title>
    <id>https://localhost:8089/services/licenser/licenses/CF6C50 . . . 72CE6C</id>
    <updated>2011-07-11T09:41:32-07:00</updated>
    <link href="/services/licenser/licenses/CF6C50 . . . 72CE6C" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/licenses/CF6C50 . . . 72CE6C" rel="list"/>
    <link href="/services/licenser/licenses/CF6C50 . . . 72CE6C" rel="remove"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="creation_time">1306168427</s:key>
        <!-- eai:acl nodes elided for brevity. -->
        <s:key name="expiration_time">2147483647</s:key>
        <s:key name="features">
          <s:list>
            <s:item>Auth</s:item>
            <s:item>FwdData</s:item>
            <s:item>RcvData</s:item>
            <s:item>LocalSearch</s:item>
            <s:item>DistSearch</s:item>
            <s:item>RcvSearch</s:item>
            <s:item>ScheduledSearch</s:item>
            <s:item>Alerting</s:item>
            <s:item>DeployClient</s:item>
            <s:item>DeployServer</s:item>
            <s:item>SplunkWeb</s:item>
            <s:item>SigningProcessor</s:item>
            <s:item>SyslogOutputProcessor</s:item>
            <s:item>CanBeRemoteMaster</s:item>
          </s:list>
        </s:key>
        <s:key name="group_id">Enterprise</s:key>
        <s:key name="label">Splunk Enterprise</s:key>
        <s:key name="license_hash">CF6C50 . . . 72CE6C</s:key>
        <s:key name="max_violations">5</s:key>
        <s:key name="quota">10737418240</s:key>
        <s:key name="sourcetypes">
          <s:list/>
        </s:key>
        <s:key name="stack_id">enterprise</s:key>
        <s:key name="status">VALID</s:key>
        <s:key name="type">enterprise</s:key>
        <s:key name="window_period">30</s:key>
      </s:dict>
    </content>
  </entry>
</feed>

licenser/licenses/{name}

DELETE licenser/licenses/{name}

Delete the license with hash corresponding to {name}.

NOTE: You cannot delete the last license out of an active group. First, deactivate the group (by switching to another group) and then perform the delete.

Request

No parameters for this request.

Response Codes

Status Code Description
200 Deleted successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to delete license.
404 License does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

No values returned for this request.

Example

Deletes the specified license.

Note: The hash for the license payload has been elided for readability


curl -k -u admin:pass --request DELETE https://localhost:8089/services/licenser/licenses/E4BF . . . FC639D


<feed xmlns="http://www.w3.org/2005/Atom" 
  xmlns:s="http://dev.splunk.com/ns/rest" 
  xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>licenses</title>
  <id>https://localhost:8089/services/licenser/licenses</id>
  <updated>2011-07-07T09:45:12-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/licenses/_new" rel="create"/>
  <opensearch:totalResults>0</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
</feed>

GET licenser/licenses/{name}

List attributes of specific license. The {name} portion of URL is actually the hash of the license payload.

Request

No parameters for this request.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view license.
404 License does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
creation_time The creation time of this license, in Coordinated Universal Time (UTC).
eai:acl See Access control lists for Splunk objects
eai:attributes See Accessing Splunk resources
expiration_time The time this license expires, in Coordinated Universal Time (UTC).
features The list of features and components enabled by this license.
group_id The ID of the group to which this license belongs.
label Plain text description of this license.
license_hash Unique identifier for the license.

The REST API uses this identifier to access this license.

max_violations The maximum number of violations allowed during the specified window period (window_period.

Searching is disabled when max_violations is exceeded.

quota Daily indexing quota, in bytes, for this license.
sourcetypes The list of allowed sourcetypes for this list. You cannot use this license to index sourcetypes that are not present in this list.

An empty list indicates all sourcetypes are allowed.

stack_id The ID of the license stack to which this license belongs.
status The status of a license can be either VALID or EXPIRED.
type Provides any additional information about the type of this license.
window_period The rolling period, in days, in which violations are aggregated.

Example

This example lists the details of the Splunk Enterprise license.

Note: The hash for the license payload has been elided for readability.


curl -k -u admin:pass https://127.0.0.1:3339/services/licenser/licenses/E4BF . . . FC639D


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:s="http://dev.splunk.com/ns/rest"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>licenses</title>
  <id>https://localhost:8089/services/licenser/licenses</id>
  <updated>2011-07-05T15:57:08-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/licenses/_new" rel="create"/>
  <opensearch:totalResults>1</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  <entry>
    <title>E4BF . . . FC639D</title>
    <id>https://localhost:8089/services/licenser/licenses/E4BF . . . FC639D</id>
    <updated>2011-07-05T15:57:08-07:00</updated>
    <link href="/services/licenser/licenses/E4BF . . . FC639D" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/licenses/E4BF . . . FC639D" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="creation_time">1300901512</s:key>
        <s:key name="eai:acl"> . . . </s:key>
        <s:key name="eai:attributes">
          <s:dict>
            <s:key name="optionalFields">
              <s:list/>
            </s:key>
            <s:key name="requiredFields">
              <s:list/>
            </s:key>
            <s:key name="wildcardFields">
              <s:list/>
            </s:key>
          </s:dict>
        </s:key>
        <s:key name="expiration_time">1314811912</s:key>
        <s:key name="features">
          <s:list>
            <s:item>Auth</s:item>
            <s:item>FwdData</s:item>
            <s:item>RcvData</s:item>
            <s:item>LocalSearch</s:item>
            <s:item>DistSearch</s:item>
            <s:item>RcvSearch</s:item>
            <s:item>ScheduledSearch</s:item>
            <s:item>Alerting</s:item>
            <s:item>DeployClient</s:item>
            <s:item>DeployServer</s:item>
            <s:item>SplunkWeb</s:item>
            <s:item>SigningProcessor</s:item>
            <s:item>SyslogOutputProcessor</s:item>
            <s:item>AllowDuplicateKeys</s:item>
            <s:item>CanBeRemoteMaster</s:item>
          </s:list>
        </s:key>
        <s:key name="group_id">Enterprise</s:key>
        <s:key name="label">Splunk Internal License</s:key>
        <s:key name="license_hash">E4BF . . . FC639D</s:key>
        <s:key name="max_violations">5</s:key>
        <s:key name="quota">10737418240</s:key>
        <s:key name="sourcetypes"><s:list/></s:key>
        <s:key name="stack_id">enterprise</s:key>
        <s:key name="status">VALID</s:key>
        <s:key name="type">enterprise</s:key>
        <s:key name="window_period">30</s:key>
      </s:dict>
    </content>
  </entry>
</feed>


licenser/messages

Provides access to licenser messages.

Messages may range from helpful warnings about being close to violations, licenses expiring or more severe alerts regarding overages and exceeding license warning window.

GET licenser/messages

Lists all messages/alerts/persisted warnings for this node.

Request

Name Type Required Default Description
count Number 30 Indicates the maximum number of entries to return. To return all entries, specify 0.
offset Number 0 Index for first item to return.
search String Search expression to filter the response. The response matches field values against the search expression. For example:

search=foo matches any object that has "foo" as a substring in a field. search=field_name%3Dfield_value restricts the match to a single field. URI-encoding is required in this example.

sort_dir Enum asc Valid values: (asc | desc)

Indicates whether to sort returned entries in ascending or descending order.

sort_key String name Field to use for sorting.
sort_mode Enum auto Valid values: (auto | alpha | alpha_case | num)

Indicates the collating sequence for sorting the returned entries. auto: If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically. alpha: Collate alphabetically. alpha_case: Collate alphabetically, case-sensitive. num: Collate numerically.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenser messages.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
category Indicates the category for the licenser message. The category can be any of the following:

license_window

pool_over_quota

stack_over_quota

orphan_slave

pool_warning_count

pool_violated_slave_count

create_time The time the message was created in the system, expressed in Coordinated Universal time (UTC).
description The actual licenser message that is displayed.
pool_id The ID of the licesne pool to which the message applies.

If a pool ID is not present, then the message in not applicable to a specific license pool.

severity Indicates the severity of the message. The severity can be any of the following:

INFO

WARN

ERROR

slave_id The ID of the license slave to which the message applies.
stack_id The ID of the license stack to which the message applies.

If a stack ID is not present, thae the message is not applicable to a specific license stack.

Example

This example lists messages from the Splunk Enterprise license.


curl -k -u admin:pass https://localhost:8089/services/licenser/messages


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
      xmlns:s="http://dev.splunk.com/ns/rest">
  <title>licensermessages</title>
  <id>https://localhost:8089/services/licenser/messages</id>
  <updated>2011-08-02T03:50:46-07:00</updated>
  <generator version="105103"/>
  <author>
    <name>Splunk</name>
  </author>
  <!-- opensearch nodes elided for brevity. -->
  <s:messages/>
  <entry>
    <title>70a19a5cfe6d7c2a678089638dee7bea</title>
    <id>https://localhost:8089/services/licenser/messages/70a19a5cfe6d7c2a678089638dee7bea</id>
    <updated>2011-08-02T03:50:46-07:00</updated>
    <link href="/services/licenser/messages/70a19a5cfe6d7c2a678089638dee7bea" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/messages/70a19a5cfe6d7c2a678089638dee7bea" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="category">pool_warning_count</s:key>
        <s:key name="create_time">1312282230</s:key>
        <s:key name="description">This pool contains slave(s) with 3 warnings</s:key>
        <!-- eai:acl nodes elided for brevity. -->
        <s:key name="pool_id"/>
        <s:key name="severity">WARN</s:key>
        <s:key name="slave_id"/>
        <s:key name="stack_id"/>
      </s:dict>
    </content>
  </entry>
</feed>

licenser/messages/{name}

GET licenser/messages/{name}

List specific message whose msgId corresponds to {name} component.

Request

No parameters for this request.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenser messages.
404 Licenser message does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
category Indicates the category for the licenser message. The category can be any of the following:

license_window

pool_over_quota

stack_over_quota

orphan_slave

pool_warning_count

pool_violated_slave_count

create_time The time the message was created in the system, expressed in Coordinated Universal time (UTC).
description The actual licenser message that is displayed.
eai:acl See Access control lists for Splunk objects
eai:attributes See Accessing Splunk resources
pool_id The ID of the licesne pool to which the message applies.

If a pool ID is not present, then the message in not applicable to a specific license pool.

severity Indicates the severity of the message. The severity can be any of the following:

INFO

WARN

ERROR

slave_id The ID of the license slave to which the message applies.
stack_id The ID of the license stack to which the message applies.

If a stack ID is not present, thae the message is not applicable to a specific license stack.

Example

This example lists the message for corresponding msgID.


curl -k -u admin:pass \
	https://127.0.0.1:3339/services/licenser/messages/2702b33a1bd369ae9209a9ecf4cb39db


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:s="http://dev.splunk.com/ns/rest"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
    <title>licensermessages</title>
    <id>https://127.0.0.1:3339/services/licenser/messages</id>
    <updated>2011-05-16T21:45:17-07:00</updated>
    <generator version="99678"/>
    <author>
        <name>Splunk</name>
    </author>
    <opensearch:totalResults>1</opensearch:totalResults>
    <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
    <opensearch:startIndex>0</opensearch:startIndex>
    <s:messages/>
    <entry>
        <title>2702b33a1bd369ae9209a9ecf4cb39db</title>
        <id>https://127.0.0.1:3339/services/licenser/messages/2702b33a1bd369ae9209a9ecf4cb39db</id>
        <updated>2011-05-16T21:45:17-07:00</updated>
        <link href="/services/licenser/messages/2702b33a1bd369ae9209a9ecf4cb39db" rel="alternate"/>
        <author>
            <name>system</name>
        </author>
        <link href="/services/licenser/messages/2702b33a1bd369ae9209a9ecf4cb39db" rel="list"/>
        <content type="text/xml">
            <s:dict>
                <s:key name="category">license_window</s:key>
                <s:key name="create_time">1305607136</s:key>
                <s:key name="description">test warnings</s:key>
                <s:key name="eai:acl">. . .</s:key>
                <s:key name="eai:attributes">
                    <s:dict>
                        <s:key name="optionalFields">
                            <s:list/>
                        </s:key>
                        <s:key name="requiredFields">
                            <s:list/>
                        </s:key>
                        <s:key name="wildcardFields">
                            <s:list/>
                        </s:key>
                    </s:dict>
                </s:key>
                <s:key name="pool_id"/>
                <s:key name="severity">WARN</s:key>
                <s:key name="slave_id"/>
                <s:key name="stack_id"/>
            </s:dict>
        </content>
    </entry>
</feed>


licenser/pools

Provides access to the licenser pools configuration.

A pool logically partitions the daily volume entitlements of a stack. You can use a license pool to divide license privileges amongst multiple slaves

GET licenser/pools

Enumerates all pools. A pool logically partitions the daily volume entitlements of a stack. You can use a pool to divide license privileges amongst multiple slaves

Request

Name Type Required Default Description
count Number 30 Indicates the maximum number of entries to return. To return all entries, specify 0.
offset Number 0 Index for first item to return.
search String Search expression to filter the response. The response matches field values against the search expression. For example:

search=foo matches any object that has "foo" as a substring in a field. search=field_name%3Dfield_value restricts the match to a single field. URI-encoding is required in this example.

sort_dir Enum asc Valid values: (asc | desc)

Indicates whether to sort returned entries in ascending or descending order.

sort_key String name Field to use for sorting.
sort_mode Enum auto Valid values: (auto | alpha | alpha_case | num)

Indicates the collating sequence for sorting the returned entries. auto: If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically. alpha: Collate alphabetically. alpha_case: Collate alphabetically, case-sensitive. num: Collate numerically.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenser pools.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
description Description of the license pool.
eai:acl See Access control lists for Splunk objects
quota The byte quota of this license pool.

MAX: maximum amount allowed by the license. You can only have one pool with MAX size in a stack.

Number: the number of bytes allowed by this license.

slaves slaveids that are members of this pool.

Returned as a list in Atom format. See example below.

slaves_usage_bytes Usage, in bytes, of slaves to this license.
stack_id Stack ID of the stack corresponding to this pool.
used_bytes Usage, in bytes, for this license pool.

Example

Lists the license pool configuration for this instance of Splunk.


curl -k -u admin:pass https://localhost:8089/services/licenser/pools


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:s="http://dev.splunk.com/ns/rest"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>pools</title>
  <id>https://localhost:8089/services/licenser/pools</id>
  <updated>2011-07-08T10:55:18-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/pools/_new" rel="create"/>
  <link href="/services/licenser/pools/_reload" rel="_reload"/>
  <opensearch:totalResults>4</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  . . .
  <entry>
    <title>auto_generated_pool_enterprise</title>
    <id>https://localhost:8089/servicesNS/nobody/system/licenser/pools/auto_generated_pool_enterprise</id>
    <updated>2011-07-08T10:55:18-07:00</updated>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_enterprise" rel="alternate"/>
    <author>
      <name>nobody</name>
    </author>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_enterprise" rel="list"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_enterprise/_reload" rel="_reload"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_enterprise" rel="edit"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_enterprise" rel="remove"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="description">auto_generated_pool_enterprise</s:key>
        <s:key name="eai:acl"> . . . </s:key>
        <s:key name="quota">MAX</s:key>
        <s:key name="slaves"><s:list><s:item>*</s:item></s:list></s:key>
        <s:key name="slaves_usage_bytes">
          <s:dict><s:key name="1F3A34AE-75DA-4680-B184-5BF309843919">26445659</s:key></s:dict>
        </s:key>
        <s:key name="stack_id">enterprise</s:key>
        <s:key name="used_bytes">26445659</s:key>
      </s:dict>
    </content>
  </entry>
  <entry>
    <title>auto_generated_pool_forwarder</title>
    <id>https://localhost:8089/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder</id>
    <updated>2011-07-08T10:55:18-07:00</updated>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="alternate"/>
    <author>
      <name>nobody</name>
    </author>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="list"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder/_reload" rel="_reload"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="edit"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="remove"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="description">auto_generated_pool_forwarder</s:key>
       <s:key name="eai:acl"> . . . </s:key>
        <s:key name="quota">MAX</s:key>
        <s:key name="slaves"><s:list><s:item>*</s:item></s:list></s:key>
        <s:key name="slaves_usage_bytes"></s:key>
        <s:key name="stack_id">forwarder</s:key>
        <s:key name="used_bytes">0</s:key>
      </s:dict>
    </content>
  </entry>
  . . .
</feed>

POST licenser/pools

Create a license pool.

Request

Name Type Required Default Description
name String
The name of the license pool you are creating.
quota String
Defines the byte quota of this pool.

Valid values:

MAX: maximum amount allowed by the license. You can only have one pool with MAX size in a stack.

Number[MB|GB]: Specify a specific size. For example, 552428800, or simply specify 50MB.

stack_id Enum
Valid values: (download-trial | enterprise | forwarder | free)

Stack ID of the stack corresponding to this pool

description String Description of this pool
slaves String Comma-separated list of slaveids that are members of this pool, or '*' to accept all slaves.

You can also specify a comma-separated list of guids to specify slaves that can connect to this pool.

Response Codes

Status Code Description
201 Created successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
402 The Splunk license in use has disabled this feature.
403 Insufficient permissions to create licenser pools.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.
503 This feature has been disabled in Splunk configuration files.

Returned Values

No values returned for this request.

Example

Create a license pool, myLicensePool, that accepts all enterprise license slaves and accepts the maximum number of bytes allowed for this license.


curl -k -u admin:pass https://localhost:8089/services/licenser/pools \
	-d name=myLicensePool \
	-d quota=MAX \
	-d slaves=* \
	-d stack_id=enterprise


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:s="http://dev.splunk.com/ns/rest"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>pools</title>
  <id>https://localhost:8089/services/licenser/pools</id>
  <updated>2011-07-08T11:31:47-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/pools/_new" rel="create"/>
  <link href="/services/licenser/pools/_reload" rel="_reload"/>
  <opensearch:totalResults>0</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
</feed>

licenser/pools/{name}

DELETE licenser/pools/{name}

Delete specified pool. Deleting pools is not supported for every pool. Certain stacks have fixed pools which cannot be deleted.

Request

No parameters for this request.

Response Codes

Status Code Description
200 Deleted successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to delete licenser pool.
404 Licenser pool does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

No values returned for this request.

Example

Deletes the auto-generated enterprise license pool.

Typically, you delete this pool to create a new enterprise license pool.


curl -k -u admin:pass --request DELETE \
	https://localhost:8089/services/licenser/pools/auto_generated_pool_enterprise


<feed xmlns="http://www.w3.org/2005/Atom" 
      xmlns:s="http://dev.splunk.com/ns/rest" 
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>pools</title>
  <id>https://localhost:8089/services/licenser/pools</id>
  <updated>2011-07-08T11:29:26-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/pools/_new" rel="create"/>
  <link href="/services/licenser/pools/_reload" rel="_reload"/>
  <opensearch:totalResults>0</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
</feed>

GET licenser/pools/{name}

Lists details of the pool specified by {name}.

A pool logically partitions the daily volume entitlements of a stack. A pool can be used to divide license privileges amongst multiple slaves

Request

No parameters for this request.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view licenser pools.
404 Licenser pool does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
description Description of the license pool.
eai:acl See Access control lists for Splunk objects
eai:attributes See Accessing Splunk resources
quota The byte quota of this license pool.

MAX: maximum amount allowed by the license. You can only have one pool with MAX size in a stack.

Number: the number of bytes allowed by this license.

slaves slaveids that are members of this pool.

Returned as a list in Atom format. See example below.

slaves_usage_bytes Usage, in bytes, of slaves to this license.
stack_id Stack ID of the stack corresponding to this pool.
used_bytes Usage, in bytes, for this license pool.

Example

Display details of the automatically generated license pool for forwarders.


curl -k -u admin:pass https://localhost:8089/services/licenser/pools/auto_generated_pool_forwarder


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:s="http://dev.splunk.com/ns/rest"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>pools</title>
  <id>https://localhost:8089/services/licenser/pools</id>
  <updated>2011-07-08T11:03:37-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <link href="/services/licenser/pools/_new" rel="create"/>
  <link href="/services/licenser/pools/_reload" rel="_reload"/>
  <opensearch:totalResults>1</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  <entry>
    <title>auto_generated_pool_forwarder</title>
    <id>https://localhost:8089/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder</id>
    <updated>2011-07-08T11:03:37-07:00</updated>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="alternate"/>
    <author>
      <name>nobody</name>
    </author>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="list"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder/_reload" rel="_reload"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="edit"/>
    <link href="/servicesNS/nobody/system/licenser/pools/auto_generated_pool_forwarder" rel="remove"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="description">auto_generated_pool_forwarder</s:key>
        <s:key name="eai:acl"> . . . </s:key>
        <s:key name="eai:attributes">
          <s:dict>
            <s:key name="optionalFields">
              <s:list>
                <s:item>append_slaves</s:item>
                <s:item>description</s:item>
                <s:item>quota</s:item>
                <s:item>slaves</s:item>
              </s:list>
            </s:key>
            <s:key name="requiredFields">
              <s:list/></s:key>
            <s:key name="wildcardFields">
              <s:list/>
            </s:key>
          </s:dict>
        </s:key>
        <s:key name="quota">MAX</s:key>
        <s:key name="slaves"><s:list><s:item>*</s:item></s:list></s:key>
        <s:key name="slaves_usage_bytes"></s:key>
        <s:key name="stack_id">forwarder</s:key>
        <s:key name="used_bytes">0</s:key>
      </s:dict>
    </content>
  </entry>
</feed>

POST licenser/pools/{name}

Edit properties of the pool specified by {name}.

Request

Name Type Required Default Description
append_slaves Boolean Flag which controls whether newly specified slaves will be appended to existing slaves list or overwritten
description String Description of this pool
quota String Defines the byte quota of this pool.

Valid values:

MAX: maximum amount allowed by the license. You can only have one pool with MAX size in a stack.

Number[MB|GB]: Specify a specific size. For example, 552428800, or simply specify 50MB.

slaves String Comma-separated list of slaveids that are members of this pool, or '*' to accept all slaves.

You can also specify a comma-separated list of guids to specify slaves that can connect to this pool.

Response Codes

Status Code Description
200 Updated successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
402 The Splunk license in use has disabled this feature.
403 Insufficient permissions to edit licenser pool.
404 Licenser pool does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.
503 This feature has been disabled in Splunk configuration files.

Returned Values

No values returned for this request.

Example

Modify the byte quota for the license pool, myLicensePool, to allow 50 MB.


curl -k -u admin:pass https://localhost:8089/services/licenser/pools/myLicensePool \
	-d quota=50MB


 . . .
  <entry>
    <title>myLicensePool</title>
    <id>https://localhost:8085/servicesNS/nobody/system/licenser/pools/myLicensePool</id>
    <updated>2011-07-24T08:46:49-07:00</updated>
    <link href="/servicesNS/nobody/system/licenser/pools/myLicensePool" rel="alternate"/>
    <author>
      <name>nobody</name>
    </author>
    <link href="/servicesNS/nobody/system/licenser/pools/myLicensePool" rel="list"/>
    <link href="/servicesNS/nobody/system/licenser/pools/myLicensePool/_reload" rel="_reload"/>
    <link href="/servicesNS/nobody/system/licenser/pools/myLicensePool" rel="edit"/>
    <link href="/servicesNS/nobody/system/licenser/pools/myLicensePool" rel="remove"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="description"></s:key>
        <!-- eai:acl nodes elided for brevity. -->
        <s:key name="eai:attributes">
          <s:dict>
            <s:key name="optionalFields">
              <s:list>
                <s:item>append_slaves</s:item>
                <s:item>description</s:item>
                <s:item>quota</s:item>
                <s:item>slaves</s:item>
              </s:list>
            </s:key>
            <s:key name="requiredFields">
              <s:list/></s:key>
            <s:key name="wildcardFields">
              <s:list/></s:key>
          </s:dict>
        </s:key>
        <s:key name="quota">552428800</s:key>
        <s:key name="slaves"><s:list><s:item>*</s:item></s:list></s:key>
        <s:key name="slaves_usage_bytes">
          <s:dict>
            <s:key name="1F3A34AE-75DA-4680-B184-5BF309843919">39846322</s:key>
          </s:dict>
        </s:key>
        <s:key name="stack_id">enterprise</s:key>
        <s:key name="used_bytes">39846322</s:key>
      </s:dict>
    </content>
  </entry>


licenser/slaves

Provides access to slaves reporting to this license master.

GET licenser/slaves

List all slaves registered to this license master. Any slave that attempts to connect to master is reported, regardless of whether it is allocated to a master licenser pool.

Request

Name Type Required Default Description
count Number 30 Indicates the maximum number of entries to return. To return all entries, specify 0.
offset Number 0 Index for first item to return.
search String Search expression to filter the response. The response matches field values against the search expression. For example:

search=foo matches any object that has "foo" as a substring in a field. search=field_name%3Dfield_value restricts the match to a single field. URI-encoding is required in this example.

sort_dir Enum asc Valid values: (asc | desc)

Indicates whether to sort returned entries in ascending or descending order.

sort_key String name Field to use for sorting.
sort_mode Enum auto Valid values: (auto | alpha | alpha_case | num)

Indicates the collating sequence for sorting the returned entries. auto: If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically. alpha: Collate alphabetically. alpha_case: Collate alphabetically, case-sensitive. num: Collate numerically.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view license slaves.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
eai:acl See Access control lists for Splunk objects
label Plain text name for the license slave.
pool_ids License pools for which this license slave is a member.
stack_ids License stacks for which this license slave is a member.
warning_count Number of license warnings issued for this license slave.

Example

This example lists all slaves to this Splunk server, which is a license master.


curl -k -u admin:pass https://localhost:8089/services/licenser/slaves


<feed xmlns="http://www.w3.org/2005/Atom"
  xmlns:s="http://dev.splunk.com/ns/rest"
  xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>slaves</title>
  <id>https://localhost:8089/services/licenser/slaves</id>
  <updated>2011-05-17T09:37:54-07:00</updated>
  <generator version="99849"/>
  <author>
    <name>Splunk</name>
  </author>
  <opensearch:totalResults>1</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  <entry>
    <title>74A43C7E-C33C-41F6-B027-E603D2C3FE68</title>
    <id>https://localhost:8089/servicesNS/nobody/system/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68</id>
    <updated>2011-05-17T09:37:54-07:00</updated>
    <link href="/servicesNS/nobody/system/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68" rel="alternate"/>
    <author>
      <name>nobody</name>
    </author>
    <link href="/servicesNS/nobody/system/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">
          <s:dict>
            <s:key name="app">system</s:key>
            <s:key name="can_write">1</s:key>
              <s:key name="modifiable">0</s:key>
            <s:key name="owner">nobody</s:key>
            <s:key name="perms">
              <s:dict>
                <s:key name="read">
                  <s:list>
                    <s:item>admin</s:item>
                  </s:list>
                </s:key>
                <s:key name="write">
                  <s:list>
                    <s:item>admin</s:item>
                  </s:list>
                </s:key>
              </s:dict>
            </s:key>
            <s:key name="sharing">system</s:key>
          </s:dict>
        </s:key>
        <s:key name="label">thething-vishalp</s:key>
        <s:key name="pool_ids">
          <s:list>
            <s:item>auto_generated_pool_enterprise</s:item>
            <s:item>auto_generated_pool_forwarder</s:item>
            <s:item>auto_generated_pool_free</s:item>
          </s:list>
        </s:key>
        <s:key name="stack_ids">
          <s:list>
            <s:item>enterprise</s:item>
            <s:item>forwarder</s:item>
            <s:item>free</s:item>
          </s:list>
        </s:key>
        <s:key name="warning_count">0</s:key>
      </s:dict>
    </content>
  </entry>
</feed>

licenser/slaves/{name}

GET licenser/slaves/{name}

List attributes of slave specified by {name}.

Request

No parameters for this request.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view license slave.
404 License slave does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
eai:acl See Access control lists for Splunk objects
eai:attributes See Accessing Splunk resources
label Plain text name for the license slave.
pool_ids License pools for which this license slave is a member.
stack_ids License stacks for which this license slave is a member.
warning_count Number of license warnings issued for this license slave.

Example

This example displays the details of a specific licenser slave.

Use
https://localhost:8089/services/licenser/slaves
to obtain the IDs of licenser slaves.
curl -k -u admin:pass \
	https://localhost:8089/services/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68


<feed xmlns="http://www.w3.org/2005/Atom"
    xmlns:s="http://dev.splunk.com/ns/rest"
    xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>slaves</title>
  <id>https://127.0.0.1:8282/services/licenser/slaves</id>
  <updated>2011-05-17T09:44:10-07:00</updated>
  <generator version="99849"/>
  <author>
    <name>Splunk</name>
  </author>
  <opensearch:totalResults>1</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  <entry>
    <title>74A43C7E-C33C-41F6-B027-E603D2C3FE68</title>
    <id>https://127.0.0.1:8282/servicesNS/nobody/system/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68</id>
    <updated>2011-05-17T09:44:10-07:00</updated>
    <link href="/servicesNS/nobody/system/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68" rel="alternate"/>
    <author>
      <name>nobody</name>
    </author>
    <link href="/servicesNS/nobody/system/licenser/slaves/74A43C7E-C33C-41F6-B027-E603D2C3FE68" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">
          <s:dict>
            <s:key name="app">system</s:key>
            <s:key name="can_write">1</s:key>
            <s:key name="modifiable">0</s:key>
            <s:key name="owner">nobody</s:key>
            <s:key name="perms">
              <s:dict>
                <s:key name="read">
                  <s:list>
                    <s:item>admin</s:item>
                  </s:list>
                </s:key>
                <s:key name="write">
                  <s:list>
                    <s:item>admin</s:item>
                  </s:list>
                </s:key>
              </s:dict>
            </s:key>
            <s:key name="sharing">system</s:key>
          </s:dict>
        </s:key>
        <s:key name="eai:attributes">
          <s:dict>
            <s:key name="optionalFields">
              <s:list/>
            </s:key>
            <s:key name="requiredFields">
              <s:list/>
            </s:key>
            <s:key name="wildcardFields">
              <s:list/>
            </s:key>
          </s:dict>
        </s:key>
        <s:key name="label">thething-vishalp</s:key>
        <s:key name="pool_ids">
          <s:list>
            <s:item>auto_generated_pool_enterprise</s:item>
            <s:item>auto_generated_pool_forwarder</s:item>
            <s:item>auto_generated_pool_free</s:item>
          </s:list>
        </s:key>
        <s:key name="stack_ids">
          <s:list>
            <s:item>enterprise</s:item>
            <s:item>forwarder</s:item>
            <s:item>free</s:item>
          </s:list>
        </s:key>
        <s:key name="warning_count">0</s:key>
      </s:dict>
    </content>
  </entry>
</feed>


licenser/stacks

Provides access to the license stack configuration.

A license stack is comprised of one or more licenses of the same "type". The daily indexing quota of a license stack is additive, so a stack represents the aggregate entitlement for a collection of licenses.

GET licenser/stacks

Enumerate all license stacks.

Request

Name Type Required Default Description
count Number 30 Indicates the maximum number of entries to return. To return all entries, specify 0.
offset Number 0 Index for first item to return.
search String Search expression to filter the response. The response matches field values against the search expression. For example:

search=foo matches any object that has "foo" as a substring in a field. search=field_name%3Dfield_value restricts the match to a single field. URI-encoding is required in this example.

sort_dir Enum asc Valid values: (asc | desc)

Indicates whether to sort returned entries in ascending or descending order.

sort_key String name Field to use for sorting.
sort_mode Enum auto Valid values: (auto | alpha | alpha_case | num)

Indicates the collating sequence for sorting the returned entries. auto: If all values of the field are numbers, collate numerically. Otherwise, collate alphabetically. alpha: Collate alphabetically. alpha_case: Collate alphabetically, case-sensitive. num: Collate numerically.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view license stacks.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
eai:acl See Access control lists for Splunk objects
label The name of this license stack.
quota The byte quota of this license stack. This value is the sum of the byte quota for all the licenses in the license stack.
type Any additional information about the type of this license stack.

Example

Displays the license stack configuration for an instance of Splunk.


curl -k -u admin:pass https://localhost:8089/services/licenser/stacks


<feed xmlns="http://www.w3.org/2005/Atom" xmlns:s="http://dev.splunk.com/ns/rest" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>stacks</title>
  <id>https://localhost:8089/services/licenser/stacks</id>
  <updated>2011-07-08T10:37:33-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <opensearch:totalResults>4</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  <entry>
    <title>download-trial</title>
    <id>https://localhost:8089/services/licenser/stacks/download-trial</id>
    <updated>2011-07-08T10:37:33-07:00</updated>
    <link href="/services/licenser/stacks/download-trial" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/stacks/download-trial" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">. . . </s:key>
        <s:key name="label">Splunk Enterprise Download Trial</s:key>
        <s:key name="quota">524288000</s:key>
        <s:key name="type">download-trial</s:key>
      </s:dict>
    </content>
  </entry>
  <entry>
    <title>enterprise</title>
    <id>https://localhost:8089/services/licenser/stacks/enterprise</id>
    <updated>2011-07-08T10:37:33-07:00</updated>
    <link href="/services/licenser/stacks/enterprise" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/stacks/enterprise" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">. . . </s:key>
        <s:key name="label">Splunk Internal License</s:key>
        <s:key name="quota">10737418240</s:key>
        <s:key name="type">enterprise</s:key>
      </s:dict>
    </content>
  </entry>
  <entry>
    <title>forwarder</title>
    <id>https://localhost:8089/services/licenser/stacks/forwarder</id>
    <updated>2011-07-08T10:37:33-07:00</updated>
    <link href="/services/licenser/stacks/forwarder" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/stacks/forwarder" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">. . . </s:key>
        <s:key name="label">Splunk Forwarder</s:key>
        <s:key name="quota">1048576</s:key>
        <s:key name="type">forwarder</s:key>
      </s:dict>
    </content>
  </entry>
  <entry>
    <title>free</title>
    <id>https://localhost:8089/services/licenser/stacks/free</id>
    <updated>2011-07-08T10:37:33-07:00</updated>
    <link href="/services/licenser/stacks/free" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/stacks/free" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">. . . </s:key>
        <s:key name="label">Splunk Free</s:key>
        <s:key name="quota">524288000</s:key>
        <s:key name="type">free</s:key>
      </s:dict>
    </content>
  </entry>
</feed>

licenser/stacks/{name}

GET licenser/stacks/{name}

Retrieve details of specific license stacks. A license stack is comprised of one or more licenses of the same "type". The daily indexing quota of a license stack is additive, so a stack represents the aggregate entitlement for a collection of licenses.

Request

No parameters for this request.

Response Codes

Status Code Description
200 Listed successfully.
400 Request error. See response body for details.
401 Authentication failure: must pass valid credentials with request.
403 Insufficient permissions to view license stacks.
404 License stack does not exist.
409 Request error: this operation is invalid for this item. See response body for details.
500 Internal server error. See response body for details.

Returned Values

Attribute Description
eai:acl See Access control lists for Splunk objects
eai:attributes See Accessing Splunk resources
label The name of this license stack.
quota The byte quota of this license stack. This value is the sum of the byte quota for all the licenses in the license stack.
type Any additional information about the type of this license stack.

Example

This example lists details of the enterprise license stack.

In this example, the enterprise license stack contains one entry.


curl -k -u admin:pass https://localhost:8089/services/enterprise


<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:s="http://dev.splunk.com/ns/rest"
      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
  <title>stacks</title>
  <id>https://localhost:8089/services/licenser/stacks</id>
  <updated>2011-07-08T10:42:44-07:00</updated>
  <generator version="102824"/>
  <author>
    <name>Splunk</name>
  </author>
  <opensearch:totalResults>1</opensearch:totalResults>
  <opensearch:itemsPerPage>30</opensearch:itemsPerPage>
  <opensearch:startIndex>0</opensearch:startIndex>
  <s:messages/>
  <entry>
    <title>enterprise</title>
    <id>https://localhost:8089/services/licenser/stacks/enterprise</id>
    <updated>2011-07-08T10:42:44-07:00</updated>
    <link href="/services/licenser/stacks/enterprise" rel="alternate"/>
    <author>
      <name>system</name>
    </author>
    <link href="/services/licenser/stacks/enterprise" rel="list"/>
    <content type="text/xml">
      <s:dict>
        <s:key name="eai:acl">
          <s:dict>
            <s:key name="app"></s:key>
            <s:key name="can_write">1</s:key>
            <s:key name="modifiable">0</s:key>
            <s:key name="owner">system</s:key>
            <s:key name="perms">
              <s:dict>
                <s:key name="read">
                  <s:list>
                    <s:item>admin</s:item>
                    </s:list>
                </s:key>
                <s:key name="write">
                  <s:list>
                    <s:item>admin</s:item>
                  </s:list>
                </s:key>
              </s:dict>
            </s:key>
            <s:key name="sharing">system</s:key>
          </s:dict>
        </s:key>
        <s:key name="eai:attributes"> . . . </s:key>
        <s:key name="label">Splunk Internal License</s:key>
        <s:key name="quota">10737418240</s:key>
        <s:key name="type">enterprise</s:key>
      </s:dict>
    </content>
  </entry>
</feed>
PREVIOUS
Knowledge
  NEXT
Outputs

This documentation applies to the following versions of Splunk® Enterprise: 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.0.6, 6.0.7, 6.0.8, 6.0.9, 6.0.10, 6.0.11, 6.0.12, 6.0.13, 6.0.14, 6.0.15, 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.1.10, 6.1.11, 6.1.12, 6.1.13, 6.1.14


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