REST API Reference Manual

License endpoint descriptions

Manage licensing configurations.

• Note: Username and password authentication is required for most endpoints and REST operations. Additional capability or role-based authorization may also be required, particularly for POST or DELETE operations.

licenser/groups

https://<host>:<mPort>/services/licenser/groups

Description

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.

Method summary

Method	Description	Formats
GET	Lists all licenser groups.	XML, JSON

---

GET licenser/groups method detail

Example

Request parameters

Pagination and filtering parameters can be used with this method.

Response data keys

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

[ Top ]

licenser/groups/{name}

https://<host>:<mPort>/services/licenser/groups/{name}

Description

Manage the {name} licenser group.

Method summary

Method	Description	Formats
GET	Lists a specific licenser group.	XML, JSON
POST	Activates specific licenser group with the side effect of deactivating the previously active one.	XML, JSON

---

GET licenser/groups/{name} method detail

Example

Request parameters

None

Response data keys

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

Application usage

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

---

POST licenser/groups/{name} method detail

Example

Request parameters

Name	Type	Default	Description
is_active required	Boolean		Active specific licenser group

Response data keys

None

Application usage

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.

[ Top ]

licenser/licenses

https://<host>:<mPort>/services/licenser/licenses

Description

Provides access to the licenses for this Splunk Enterprise instance.

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

Method summary

Method	Description	Formats
GET	Lists all licenses added.	XML, JSON
POST	Add a license entitlement to this instance.	XML, JSON

---

GET licenser/licenses method detail

Example

Request parameters

Pagination and filtering parameters can be used with this method.

Response data keys

Name	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.

Application usage

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.

---

POST licenser/licenses method detail

Example

Request parameters

Name	Type	Default	Description
name required	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 data keys

Name	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.

[ Top ]

licenser/licenses/{name}

https://<host>:<mPort>/services/licenser/licenses/{name}

Description

Manage the {name} license.

Method summary

Method	Description	Formats
DELETE	Delete the license with hash corresponding to {name}.	XML, JSON
GET	List attributes of specific license.	XML, JSON

---

DELETE licenser/licenses/{name} method detail

Example

Request parameters

None

Response data keys

None

Application usage

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.

---

GET licenser/licenses/{name} method detail

Example

Request parameters

None

Response data keys

Name	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.

Application usage

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

[ Top ]

licenser/localslave

https://<host>:<mPort>/services/licenser/localslave

Authentication: Required

Description

Get information about relevant license state for the splunk instance.

Method summary

Method	Description	Formats
GET	Get information about relevant license state for the splunk instance	XML, JSON

---

GET licenser/localslave method detail

Example

Request parameters

None

Response data keys

Name	Description
add_ons	List of add-ons resident on this instance, and add-on parameters.
connection_timeout	Instance connection timeout (seconds).
features	List of key-value pairs of the following features and their ENABLED/DISABLED status: Acceleration AdvancedSearchCommands AdvancedXML Alerting AllowDuplicateKeys Auth CanBeRemoteMaster CustomRoles DeployClient DeployServer DistSearch FwdData GuestPass KVStore LDAPAuth LocalSearch MultisiteClustering NontableLookups RcvData RcvSearch ResetWarnings">DISABLED_DUE_TO_LICENSE</s:key> RollingWindowAlerts ScheduledAlerts ScheduledReports ScheduledSearch SearchheadPooling SigningProcessor SplunkWeb SyslogOutputProcessor UnisiteClustering
last_master_contact_attempt_time	Time of last attempt to contact master.
last_master_contact_success_time	Time of last successful attempt to contact master.
last_trackerdb_service_time	Time of last license servicing, tracking persistent store.
license_keys	List of license keys this instance is using.
master_guid	Master license GUID.
master_uri	Master license URI.
receive_timeout	Network layer receive timeout for communication to master (seconds).
send_timeout	Network layer send timeout for communication to master (seconds).
slave_id	This instance GUID.
slave_label	This instance server name.
squash_threshold	Threshold that enables source/host squashing of rows of usage data sent to master periodically.

[ Top ]

licenser/messages

https://<host>:<mPort>/services/licenser/messages

Description

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.

Method summary

Method	Description	Formats
GET	Lists all messages/alerts/persisted warnings for this node.	XML, JSON

---

GET licenser/messages method detail

Example

Request parameters

Pagination and filtering parameters can be used with this method.

Response data keys

Name	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.

[ Top ]

licenser/messages/{name}

https://<host>:<mPort>/services/licenser/messages/{name}

Description

Get the message with message ID {name}.

Method summary

Method	Description	Formats
GET	List specific message whose msgId corresponds to {name} component.	XML, JSON

---

GET licenser/messages/{name} method detail

Example

Request parameters

None

Response data keys

Name	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.

[ Top ]

licenser/pools

https://<host>:<mPort>/services/licenser/pools

Description

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.

Method summary

Method	Description	Formats
GET	Enumerates all pools.	XML, JSON
POST	Create a license pool.	XML, JSON

---

GET licenser/pools method detail

Example

Request parameters

Pagination and filtering parameters can be used with this method.

Response data keys

Name	Description
description	Description of the license pool.
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.

---

POST licenser/pools method detail

Example

Request parameters

description	String		Description of this pool
Name	Type	Default	Description
name required	String		The name of the license pool you are creating.
quota required	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.
stack_id required	Enum		Valid values: (download-trial | Enterprise | Forwarder | Free | Lite | Lite_Free) Stack ID of the stack corresponding to this pool

Response data keys

None

[ Top ]

licenser/pools/{name}

https://<host>:<mPort>/services/licenser/pools/{name}

Description

Manage the {name} license pool.

Method summary

Method	Description	Formats
DELETE	Delete specified pool.	XML, JSON
GET	Lists details of the pool specified by {name}.	XML, JSON
POST	Edit properties of the pool specified by {name}.	XML, JSON

---

DELETE licenser/pools/{name} method detail

Example

Request parameters

None

Response data keys

None

Application usage

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

---

GET licenser/pools/{name} method detail

Example

Request parameters

None

Response data keys

Name	Description
description	Description of the license pool.
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.

---

POST licenser/pools/{name} method detail

Example

Request parameters

Name	Type	Default	Description
append_slaves	Boolean		Flag which controls whether newly specified slaves is 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 data keys

None

[ Top ]

licenser/slaves

https://<host>:<mPort>/services/licenser/slaves

Description

Provides access to slaves reporting to this license master.

Method summary

Method	Description	Formats
GET	List all slaves registered to this license master.	XML, JSON

---

GET licenser/slaves method detail

Example

Request parameters

Pagination and filtering parameters can be used with this method.

Response data keys

Name	Description
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.

Application usage

Any slave that attempts to connect to master is reported, regardless of whether it is allocated to a master licenser pool.

[ Top ]

licenser/slaves/{name}

https://<host>:<mPort>/services/licenser/slaves/{name}

Description

Get {name} licenser slave license information.

Method summary

Method	Description	Formats
GET	List attributes of slave specified by {name}.	XML, JSON

---

GET licenser/slaves/{name} method detail

Example

Request parameters

None

Response data keys

Name	Description
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.

[ Top ]

licenser/stacks

https://<host>:<mPort>/services/licenser/stacks

Description

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.

Method summary

Method	Description	Formats
GET	Enumerate all license stacks.	XML, JSON

---

GET licenser/stacks method detail

Example

Request parameters

Pagination and filtering parameters can be used with this method.

Response data keys

Name	Description
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.

[ Top ]

licenser/stacks/{name}

https://<host>:<mPort>/services/licenser/stacks/{name}

Description

Get {name} license stack information.

Method summary

Method	Description	Formats
GET	Retrieve details of specific license stacks.	XML, JSON

---

GET licenser/stacks/{name} method detail

Example

Request parameters

None

Response data keys

Name	Description
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.

Application usage

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.

[ Top ]