Using the REST API reference

Use the REST API Reference to learn about available endpoints and operations for accessing, creating, updating, or deleting resources. See the REST API User Manual to learn about the Splunk REST API basic concepts.

Splunk Cloud REST API usage

There are some REST API access and usage differences between Splunk Cloud and Splunk Enterprise. If you are using Splunk Cloud, review details in Using the REST API with Splunk Cloud.

Using endpoint reference entries

Expand a GET, POST, or DELETE element to show the following usage information about the operation.

Request parameter information and requirements.

Returned values included in the response.

Example request and response.

Request and response details

Pagination and filtering parameters

In addition to the parameters specific to each endpoint and operation, the following request parameters are valid for some GET methods.

Name

Datatype

Default

Description

count

Number

30

Maximum number of entries to return. Set value to 0 to get all available entries.

f

String

Filters the response to include only the named values. Specify multiple times to return multiple values.

Examples:

f=qualifiedSearch returns only the value for qualifiedSearch.f=s* returns all the values that have names beginning with s.
f=qualifiedSearch&f=is_visible returns the values for qualifiedSearch as well as is_visible.

offset

Number

0

Index of first item to return.

search

String

Response filter, where the response field values are matched against this search expression.

Example:

search=foo matches on any field with the string foo in the name.
search=field_name%3Dfield_value restricts the match to a single field. (Requires URI-encoding.)

Returned values

The response to GET and other requests typically includes key-value pairs representing details about the resource that you are accessing. Returned values specific to the resource and/or operation are listed along with their descriptions.

HTTP status codes

Responses can include HTTP status codes. Standard HTTP status codes are not included in endpoint documentation, but status codes with specific meaning for an endpoint and/or operation are noted.

Error messages

Requests with an error, such as a missing required parameter, can prompt an error response like the following example.

EAI response data

EAI response data, the <eai:acl> and <eai:attributes> elements, typically apply to all endpoints and are configuration-dependent, so redundant explanation is omitted. These elements are also elided from the response examples to make the documentation easier to read.

Access Control List (ACL) [eai:acl]

The REST implementation enforces ownership and permissions for a resource based on application context namespace. The ACL includes the following parameters.

Parameter

Description

app

The app context for the resource. Allowed values are:

The name of an app

system

can_list

For internal use only for the Splunk Web manager UI.

can_share_*

Indicates whether or not the current user can change the sharing state. The sharing state can be one of:

can_share_app = App-level sharing

can_share_global = Global sharing

can_share_user = User-level sharing

can_write

Indicates whether or not the current user can edit this item.

owner

The user that owns the resource.

A value of nobody indicates that all users have access to the resource, but that write access to the resource might be restricted.

modifiable

Indicates whether or not you can change the Access Control List (ACL).

Set to false for items not controlled by ACLs, such as items under /server/logger.

perms.read

Properties that indicate read permissions of the resource.

perms.write

Properties that indicate write permissions of the resource.

removable

Indicates if an admin or user with sufficient permissions can remove the entity.

sharing

Indicates how the resource is shared. Allowed values are:

app = Shared through an app.

global = Shared to all apps.

user = Private to a user.

Note: You can append /acl to an endpoint to access its ACL properties. For more information, see Access Control List in the REST API User Manual.

EAI attributes [eai:attributes]

The eai:attributes element shows the mandatory and optional fields.

Attribute

Description

optionalFields

Field is optional.

requiredFields

Field is required.

wildcardFields

Field can use wildcard.

References

See the following resources for more information on working with the Splunk REST API.

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.

Feedback submitted, thanks!

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

Your Comment Has Been Posted Above

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website.
Learn more (including how to update your settings) here »