Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF

Acrobat logo Download topic as PDF

Get data from Ingest Service

Use the Ingest Service source function to get data from the Ingest REST API. This is a source function that filters your data to only ingest data from the Ingest REST API Service. For information on how to send data to DSP using the Ingest REST API, see Use the Ingest REST API to send test events to your pipeline.

Function output schema

This function outputs data pipeline events using the Event schema for events or Metrics schema for metrics.

Required arguments

connection_id
Syntax: string
Description: The ID of your Ingest REST API connection. Must be set to rest_api:all.
Example: "rest_api:all"

Optional arguments

initial_position
Syntax: LATEST | TRIM_HORIZON
Description: The position in the data stream where you want to start reading data. Defaults to LATEST.
  • LATEST: Start reading data from the latest position on the data stream.
  • TRIM_HORIZON: Start reading data from the very beginning of the data stream.
Example: "LATEST"

SPL2 example

You can write the function using arguments in this exact order.

| from ingest_rest_api("rest_api:all", "TRIM_HORIZON") |... ;

Alternatively, you can use named arguments in any order, and omit the optional argument if you just want to use the default value. See the "Named arguments" section in SPL2 syntax for more details. The following SPL2 example omits the initial_position argument.

| from ingest_rest_api(connection_id: "rest_api:all") |... ;

Limitations of the Ingest service

The maximum supported size for a record is 5MB. If any records exceed that size, the Ingest service returns an error.

Last modified on 10 November, 2020
PREVIOUS
Get data from Forwarders Service
  NEXT
Get data from Amazon CloudWatch

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters