REST API

REST API

noun

Use the Splunk REST API to interact with resources in a deployment. Run searches, monitor the deployment, and manage configurations or objects.

REST API endpoints are served from the splunkd server. Operations on an endpoint can have required parameters and might have capability restrictions. Depending on the operation, responses from endpoints can include values representing resource state and/or other details.

The REST API supports typical create, read, update, and delete options using the following operations.

• Use a GET request to access information about a resource.
• Use a POST request to create and/or update a resource.
• Use a DELETE request to remove a resource.

For more information

In the REST API Reference Manual:

• About the REST API Reference Manual
• URI quick reference

In the REST API User Manual:

• Basic concepts