Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Inputs

Input configuration parameters:

ParameterDescriptionDefault value
idA uuid that uniquely identifies the input.Not set
labelA human-readable name for the input.Not set
indexThe uuid of the index that this input will send events toNot set
token_requiredA boolean value indicating whether a token is required to access the input. If true, the input will only accept events with a valid token.Not set
time_extractorThe time extractor to use for this input. See Time Extractors for more information.{ "type": "Field", "field": "timestamp", "format": "%+" }

Input tokens are managed separately from the normal input configuration API. When token_required is true, Crystalline generates a token for new inputs; retrieve or rotate it with the input token endpoints. Bootstrap configuration can provide a token value explicitly, but normal input create/update requests do not accept or return it.