Splunk · Schema

HecTokenCreateRequest

AnalyticsData AnalysisLoggingMachine DataMonitoringObservabilityPlatformSecuritySIEM

Properties

Name Type Description
name string Name for the new HEC token
index string Default destination index
indexes string Comma-separated list of allowed indexes
sourcetype string Default sourcetype
source string Default source value
host string Default host value
disabled boolean Whether to create the token in disabled state
useACK boolean Whether to enable indexer acknowledgment
View JSON Schema on GitHub

JSON Schema

splunk-hectokencreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HecTokenCreateRequest",
  "title": "HecTokenCreateRequest",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the new HEC token",
      "example": "Example Title"
    },
    "index": {
      "type": "string",
      "description": "Default destination index",
      "default": "main",
      "example": "example_value"
    },
    "indexes": {
      "type": "string",
      "description": "Comma-separated list of allowed indexes",
      "example": "example_value"
    },
    "sourcetype": {
      "type": "string",
      "description": "Default sourcetype",
      "example": "example_value"
    },
    "source": {
      "type": "string",
      "description": "Default source value",
      "example": "example_value"
    },
    "host": {
      "type": "string",
      "description": "Default host value",
      "example": "example_value"
    },
    "disabled": {
      "type": "boolean",
      "description": "Whether to create the token in disabled state",
      "default": false,
      "example": true
    },
    "useACK": {
      "type": "boolean",
      "description": "Whether to enable indexer acknowledgment",
      "default": false,
      "example": true
    }
  }
}