How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Splunk Index API

Endpoints for managing Splunk indexes, which store and organize ingested data. Indexes can be created, modified, listed, and configured for retention and storage policies.

Splunk Index API is one of 14 APIs that Splunk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Index. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, a JSON-LD context, and 2 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 9.4.0.

Requests are made against a single base URL, https://{host}:{port}.

5 operations 2 paths 6 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
9.4.0
Server
https://{host}:{port}
Authentication
HTTP Bearer, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Splunk Index API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP basic authentication (BasicAuth). An API key is passed in the header as Authorization (HecToken). By default, every request must be authenticated.

  • BearerAuth — Splunk authentication token. Obtain a session key by authenticating to /services/auth/login or use a pre-configured bearer token from Settings Tokens in Splunk…
  • BasicAuth — HTTP Basic authentication with a valid Splunk username and password. The credentials are sent as a Base64-encoded string in the Authorization header.
  • HecToken — HTTP Event Collector token. Send as "Splunk " in the Authorization header. Tokens are configured in Splunk Web under Settings Data Inputs HTTP Event Collector.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Index 5

Endpoints for managing Splunk indexes, which store and organize ingested data. Indexes can be created, modified, listed, and configured for retention and storage policies.

GET
/services/data/indexes
List Indexes
listIndexes 7 params → 200401403
POST
/services/data/indexes
Create a New Index
createIndex 1 param body → 201400401403409
GET
/services/data/indexes/{name}
Get Index Details
getIndex 2 params → 200404401
POST
/services/data/indexes/{name}
Update Index Configuration
updateIndex 2 params body → 200400404401
DELETE
/services/data/indexes/{name}
Delete an Index
deleteIndex 1 param → 200404401403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are IndexCreateRequest (10 properties), IndexUpdateRequest (7 properties), IndexList (4 properties), Paging (3 properties). Each schema is shown below with its type and property counts.

IndexUpdateRequest
object
7 properties
IndexCreateRequest
object
10 properties 1 required
Index
object
2 properties
Paging
object
3 properties
ErrorResponse
object
1 property
IndexList
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

splunk-index-api-openapi.yml Raw ↑

Other APIs Splunk publishes across the network.

Splunk Cloud Platform REST API
Splunk Cloud Admin Config Service (ACS) API
Splunk Observability Cloud API
Splunk SOAR REST API
Splunk Enterprise Security API
Splunk IT Service Intelligence (ITSI) REST API
Splunk HTTP Event Collector (HEC) API
Splunk Intelligence Management API
Splunk SOAR Playbook Automation API
Splunk AppInspect API
Splunk Data Inputs API
Where this information came from

This is an independent, third-party profile of Splunk Index API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.