parkingtaya.blogg.se - Splunk itsi maintenance rest api

SPLUNK ITSI MAINTENANCE REST API HOW TO
SPLUNK ITSI MAINTENANCE REST API UPDATE
SPLUNK ITSI MAINTENANCE REST API MANUAL
SPLUNK ITSI MAINTENANCE REST API SOFTWARE
SPLUNK ITSI MAINTENANCE REST API CODE

This is the mechanism used when you access resources using a Web browser. Splunk Enterprise also supports basic authentication, as defined by RFC 1945.

Get a session key using the /services/auth/login endpoint:Ĭurl -k -H "Authorization: Bearer eyJfd3e46a31246da7ea7f109e7f95fd".

The API supports token-based authentication using the standard HTTP Authorization header. The default authenticated session timeout is one hour, which Splunk Enterprise users can adjust using the sessionTimeout setting in the stanza of the nf file.Īuthentication with HTTP Authorization tokens

To determine the capabilities assigned to a role, select Settings > Access controls and click Roles.

To view the roles assigned to a user, select Settings > Access controls and click Users.

Users with an administrative role, such as admin, can access authorization information in Splunk Web. Splunk users must have role or capability-based authorization to use REST endpoints. If you do not hold a valid authentication token, then authentication with credentials is the only other available method for access to endpoints and REST operations. To learn more about setting up authentication with tokens, see Set up authentication with tokens in the Securing Splunk Enterprise manual. Tokens are available for both native Splunk authentication and external authentication through either the LDAP or SAML schemes. data-urlencode search="index=_internal source=*metrics.log"Ĭreate authentication tokens to use the REST APIs. However, if you are having problems logging in to an endpoint or running a search, use the -data-urlencode parameter instead of -d to ensure all characters in the string are URI-encoded. In most instances, the -d parameter will sufficiently URI-encode a search string. Endpoints with a search string parameter also require URI-encoding if the search string has the characters equal ( =), ampersand ( &), question mark ( ?), percent ( %), or a space, which are interpreted as part of the HTTP request. To access this endpoint with the value of /var/log for :

For example, consider the GET operation for this endpoint: Typically, parameters with a path or URL value require URI-encoding. You might also need URI-encoding for your cURL commands. In the REST API reference, example cURL commands are formatted for a Unix shell or Bash, and different operating systems and shells might require different syntax.

SPLUNK ITSI MAINTENANCE REST API CODE

Use the DELETE method to delete an endpoint from the resource hierarchy.Īll methods return a HTTP status code to indicate the success of the operation or cause of a failure to fulfill the request.

SPLUNK ITSI MAINTENANCE REST API UPDATE

Use the POST method to create a resource or update existing resource data. Otherwise, the endpoint is a terminal node in the resource hierarchy and the GET request gets the current resource state as a list of property key-value pairs. Iterate over the resource hierarchy to see the instantiated endpoints. If the endpoint represents a collection, list the members of the collection. Corresponding CRUD operations appear in brackets.

SPLUNK ITSI MAINTENANCE REST API MANUAL

See the REST API Reference Manual for which endpoints support which methods. The Splunk REST API exposes the following REST methods subset.

To use the unsecure, HTTP protocol, set the enableSplunkdSSL property in the nf file to false. When you use the REST API, use the splunkd management port, 8089, and the secure HTTPS protocol.

Send GET requests again to verify that you deleted sampleMessage. The Uniform Resource Locator (URL) addressing defined as part of the HTTP protocol maps to Splunk platform resources identified by their Uniform Resource Identifier (URI).įor example, a request to the following URL will return a list of applications installed on your server: Your browser uses the same protocol, so you can use it to send API requests to the server. This REST API implementation accesses domain resources with corresponding endpoints, using the HTTP protocol. The API conforms to the Representational State Transfer (REST) architectural style. Each collection has some combination of resources and other collections. A resource is a single, named, object stored by splunkd, such as a job, a TCP raw input, or a saved search. The API is organized around object and configuration resources.

SPLUNK ITSI MAINTENANCE REST API HOW TO

To see additional tutorials, including how to use the Splunk platform REST API with Splunk Cloud Platform, see the REST API Tutorials Manual API functions and organizationĪPI functions allow you to either run searches, or manage objects and configuration. To see a list of available endpoints and operations for accessing, creating, updating, or deleting resources, see the REST API Reference Manual.

SPLUNK ITSI MAINTENANCE REST API SOFTWARE

The Splunk platform REST API gives you access to the same information and functionality available to core system software and Splunk Web. Basic concepts about the Splunk platform REST API