Splunk · Example Payload

Splunk Updateindex Example

AnalyticsData AnalysisLoggingMachine DataMonitoringObservabilityPlatformSecuritySIEM

Splunk Updateindex Example is an example object payload from Splunk, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "updateIndex",
  "method": "POST",
  "path": "/services/data/indexes/{name}",
  "summary": "Update Index Configuration",
  "requestExamples": [
    {
      "contentType": "application/x-www-form-urlencoded",
      "name": "UpdateindexRequestExample",
      "example": {
        "maxTotalDataSizeMB": 10,
        "frozenTimePeriodInSecs": 10,
        "maxHotBuckets": 10,
        "maxWarmDBCount": 10,
        "disabled": true,
        "coldToFrozenDir": "example_value",
        "coldToFrozenScript": "example_value"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Updateindex200Example",
      "example": {
        "name": "Example Title",
        "content": {
          "datatype": "event",
          "totalEventCount": 10,
          "currentDBSizeMB": 10,
          "maxDataSize": "auto",
          "maxTotalDataSizeMB": 10,
          "maxHotBuckets": 10,
          "maxWarmDBCount": 10,
          "frozenTimePeriodInSecs": 10,
          "homePath": "example_value",
          "coldPath": "example_value",
          "thawedPath": "example_value",
          "disabled": true,
          "isInternal": true,
          "minTime": "example_value",
          "maxTime": "example_value",
          "repFactor": "example_value",
          "enableOnlineBucketRepair": true,
          "quarantinePastSecs": 10,
          "quarantineFutureSecs": 10
        }
      }
    }
  ]
}