Splunk · Schema

IndexUpdateRequest

AnalyticsData AnalysisLoggingMachine DataMonitoringObservabilityPlatformSecuritySIEM

Properties

Name Type Description
maxTotalDataSizeMB integer Maximum total size of the index in MB
frozenTimePeriodInSecs integer Seconds until data is frozen
maxHotBuckets integer Maximum number of hot buckets
maxWarmDBCount integer Maximum number of warm buckets
disabled boolean Whether to disable the index
coldToFrozenDir string Path to archive frozen buckets to. If not set, frozen data is deleted.
coldToFrozenScript string Script to run when freezing buckets
View JSON Schema on GitHub

JSON Schema

splunk-enterprise-rest-index-update-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "IndexUpdateRequest",
  "type": "object",
  "properties": {
    "maxTotalDataSizeMB": {
      "type": "integer",
      "description": "Maximum total size of the index in MB"
    },
    "frozenTimePeriodInSecs": {
      "type": "integer",
      "description": "Seconds until data is frozen"
    },
    "maxHotBuckets": {
      "type": "integer",
      "description": "Maximum number of hot buckets"
    },
    "maxWarmDBCount": {
      "type": "integer",
      "description": "Maximum number of warm buckets"
    },
    "disabled": {
      "type": "boolean",
      "description": "Whether to disable the index"
    },
    "coldToFrozenDir": {
      "type": "string",
      "description": "Path to archive frozen buckets to. If not set, frozen data is deleted."
    },
    "coldToFrozenScript": {
      "type": "string",
      "description": "Script to run when freezing buckets"
    }
  }
}