--- title: "Update metadata for an HEC token for a Splunk HEC Source" method: PATCH path: "/system/inputs/{id}/hectoken/{token}" tags: ["sources"] --- # Update metadata for an HEC token for a Splunk HEC Source `PATCH /system/inputs/{id}/hectoken/{token}` Update the metadata for the specified HEC token for the specified Splunk HEC Source. ## Path parameters - `id` string, required - `token` string, required ## Request body - UpdateHecTokenRequest - `allowedIndexesAtToken` string[] - `description` string - `enabled` boolean - `metadata` EventBreakerRuleFields[] - `name` string, required - `value` string, required ## Response `200` a list of InputSplunkHec objects - CountedInputSplunkHec - `count` integer — number of items present in the items array - `items` InputSplunkHec[] - `id` string — Unique ID for this input - `type` 'splunk_hec', required - `disabled` boolean - `pipeline` string — Pipeline to process data from this Source before sending it through the Routes - `sendToRoutes` boolean — Select whether to send data to Routes, or directly to Destinations. - `environment` string — Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere. - `pqEnabled` boolean — Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers). - `streamtags` string[] — Tags for filtering and grouping in @{product} - `connections` ItemsTypeConnectionsOptional[] — Direct connections to Destinations, and optionally via a Pipeline or a Pack - `pipeline` string - `output` string - `pq` PqType - `mode` 'smart' | 'always' — With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine. - `maxBufferSize` number — The maximum number of events to hold in memory before writing the events to disk - `commitFrequency` number — The number of events to send downstream before committing that Stream has read them - `maxFileSize` string — The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc. - `maxSize` string — The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc. - `path` string — The location for the persistent queue files. To this field's value, the system will append: //inputs/ - `compress` 'none' | 'gzip' — Codec to use to compress the persisted data - `pqControls` object - `host` string, required — Address to bind on. Defaults to 0.0.0.0 (all addresses). - `port` number, required — Port to listen on - `authTokens` object[] — Shared secrets to be provided by any client (Authorization: ). If empty, unauthorized access is permitted. - `authType` 'manual' | 'secret' — Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate - `tokenSecret` string — Select or create a stored text secret - `token` string, required — Shared secret to be provided by any client (Authorization: ) - `enabled` boolean - `description` string — Optional token description - `allowedIndexesAtToken` string[] — Enter the values you want to allow in the HEC event index field at the token level. Supports wildcards. To skip validation, leave blank. - `metadata` ItemsTypeMetadata[] — Fields to add to events referencing this token - `name` string, required - `value` string, required — JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.) - `tls` TlsSettingsServerSideType - `disabled` boolean - `requestCert` boolean — Require clients to present their certificates. Used to perform client authentication using SSL certs. - `rejectUnauthorized` boolean — Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's) - `commonNameRegex` string — Regex matching allowable common names in peer certificates' subject attribute - `certificateName` string — The name of the predefined certificate - `privKeyPath` string — Path on server containing the private key to use. PEM format. Can reference $ENV_VARS. - `passphrase` string — Passphrase to use to decrypt private key - `certPath` string — Path on server containing certificates to use. PEM format. Can reference $ENV_VARS. - `caPath` string — Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS. - `minVersion` 'TLSv1' | 'TLSv1.1' | 'TLSv1.2' | 'TLSv1.3' - `maxVersion` 'TLSv1' | 'TLSv1.1' | 'TLSv1.2' | 'TLSv1.3' - `maxActiveReq` number — Maximum number of active requests allowed per Worker Process. Set to 0 for unlimited. Caution: Increasing the limit above the default value, or setting it to unlimited, may degrade performance and reduce throughput. - `maxRequestsPerSocket` integer — Maximum number of requests per socket before @{product} instructs the client to close the connection. Default is 0 (unlimited). - `enableProxyHeader` boolean — Extract the client IP and port from PROXY protocol v1/v2. When enabled, the X-Forwarded-For header is ignored. Disable to use the X-Forwarded-For header for client IP extraction. - `captureHeaders` boolean — Add request headers to events, in the __headers field - `activityLogSampleRate` number — How often request activity is logged at the `info` level. A value of 1 would log every request, 10 every 10th request, etc. - `requestTimeout` number — How long to wait for an incoming request to complete before aborting it. Use 0 to disable. - `socketTimeout` number — How long @{product} should wait before assuming that an inactive socket has timed out. To wait forever, set to 0. - `keepAliveTimeout` number — After the last response is sent, @{product} will wait this long for additional data before closing the socket connection. Minimum 1 second, maximum 600 seconds (10 minutes). - `ipAllowlistRegex` string — Messages from matched IP addresses will be processed, unless also matched by the denylist - `ipDenylistRegex` string — Messages from matched IP addresses will be ignored. This takes precedence over the allowlist. - `splunkHecAPI` string, required — Absolute path on which to listen for the Splunk HTTP Event Collector API requests. This input supports the /event, /raw and /s2s endpoints. - `metadata` ItemsTypeMetadata[] — Fields to add to every event. Overrides fields added at the token or request level. See [the Source documentation](https://docs.cribl.io/stream/sources-splunk-hec/#fields) for more info. - `name` string, required - `value` string, required — JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.) - `allowedIndexes` string[] — List values allowed in HEC event index field. Leave blank to skip validation. Supports wildcards. The values here can expand index validation at the token level. - `splunkHecAcks` boolean — Enable Splunk HEC acknowledgements - `breakerRulesets` string[] — A list of event-breaking rulesets that will be applied, in order, to the input data stream - `staleChannelFlushMs` number — How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines - `useFwdTimezone` boolean — Event Breakers will determine events' time zone from UF-provided metadata, when TZ can't be inferred from the raw event - `dropControlFields` boolean — Drop Splunk control fields such as `crcSalt` and `_savedPort`. If disabled, control fields are stored in the internal field `__ctrlFields`. - `extractMetrics` boolean — Extract and process Splunk-generated metrics as Cribl metrics - `accessControlAllowOrigin` string[] — Optionally, list HTTP origins to which @{product} should send CORS (cross-origin resource sharing) Access-Control-Allow-* headers. Supports wildcards. - `accessControlAllowHeaders` string[] — Optionally, list HTTP headers that @{product} will send to allowed origins as "Access-Control-Allow-Headers" in a CORS preflight response. Use "*" to allow all headers. - `emitTokenMetrics` boolean — Emit per-token (.http.perToken) and summary (.http.summary) request metrics - `description` string - `__template_host` string — Binds 'host' to a variable for dynamic value resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID (group-scoped). Variable value overrides 'host' at runtime. - `__template_port` string — Binds 'port' to a variable for dynamic value resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID (group-scoped). Variable value overrides 'port' at runtime. - `__template_splunkHecAPI` string — Binds 'splunkHecAPI' to a variable for dynamic value resolution. Set to variable ID (pack-scoped) or 'cribl.'/'edge.' prefixed ID (group-scoped). Variable value overrides 'splunkHecAPI' at runtime. ## Other responses - `401` — Unauthorized - `500` — Unexpected error ## Changes - **2026-03-06** `11df16b26c1d` — 1 warning, 3 info - removed the optional property `items/items/enableHealthCheck` from the response with the `200` status - added the optional property `items/items/__template_host` to the response with the `200` status - added the optional property `items/items/__template_port` to the response with the `200` status - added the optional property `items/items/__template_splunkHecAPI` to the response with the `200` status - **2026-01-24** `84748faee3ef` — 3 breaking, 35 info - the response property `items/items/connections/items/output` became optional for the status `200` - the `items/items/authTokens/items/token` response's property type/format changed from ``/`` to `string`/`` for status `200` - the `items/items/authTokens/items/tokenSecret` response's property type/format changed from ``/`` to `string`/`` for status `200` - the `activityLogSampleRate` response's property default value `100` was removed for the status `200` - …34 more - …this revision’s changelog is incomplete - …earlier changes not shown [Full history](https://skmtc.dev/criblio/apis/cribl-api-reference/changes/system/inputs/:id/hectoken/:token/patch.md) --- [API](https://skmtc.dev/criblio/apis/cribl-api-reference.md) · [All operations](https://skmtc.dev/criblio/apis/cribl-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/criblio/cribl-api-reference/revisions/11df16b26c1d/schema)