Output: http-post

Run HTTP POST requests

Example

Pipe Language Snippet:

http-post:
  url: http://httpbin.org/post

Field Summary

Field Name	Type	Description	Default
batch	integer or the 'document'	Maximum number of events in an output batch. If 'document' send on end of document	-
timeout	interval	Interval after which the batch is sent, to keep throughput going	100ms
header	templated text	Put a header line before the batch	-
footer	templated text	Put a header line after the last line of the batch	-
use-document-marker	bool	Enrich the pipe metadata with a document marker (for document handling in batch mode)	false
url	url	Connect to this address	-
body-field	field	A field containing the body	-
headers	array of maps	Headers to send with the query	-
retry	Retry	For operations that could potentially fail	-
insecure	bool	Ignore TLS certificate validation errors (This is unsafe to use)	false

Fields

batch

Type: integer or the 'document'

Maximum number of events in an output batch. If 'document' send on end of document

timeout

Type: interval

Default: 100ms

Interval after which the batch is sent, to keep throughput going

header

Type: templated text

Put a header line before the batch

footer

Type: templated text

Put a header line after the last line of the batch

use-document-marker

Type: bool

Default: false

Enrich the pipe metadata with a document marker (for document handling in batch mode)

url

Type: url

Connect to this address

If the url changes, then header and/or footer can be invoked

body-field

Type: field
Alias: body

A field containing the body

Example

Pipe Language Snippet:

http-post:
  url: http://httpbin.org/post
  body-field: some-field

headers

Type: array of maps

Headers to send with the query

Example

Pipe Language Snippet:

http-post:
  url: http://httpbin.org/post
  headers:
    - custom-header: some data

retry

Type: Retry

For operations that could potentially fail

Field Name	Type	Description	Default
count	integer	How many attempts to make before declaring failure	-
pause	duration	How long to pause before re-trying	-
forever	bool	Keep trying until success is declared	false

  count

Type: integer

How many attempts to make before declaring failure

Example

Pipe Language Snippet:

exec:
  command: echo 'one two'
  retry:
    count: 1

Output:

{"_raw":"one two"}

  pause

Type: duration

How long to pause before re-trying

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Example

Pipe Language Snippet:

exec:
  command: echo 'one two'
  retry:
    count: 6
    pause: 10s

Output:

{"_raw":"one two"}

  forever

Type: bool

Default: false

Keep trying until success is declared

Accepts human-friendly formats, like 1m (for 1 minute) and 4h (for 4 hours)

Example

Pipe Language Snippet:

exec:
  command: echo 'one two'
  retry:
    forever: true

Output:

{"_raw":"one two"}

insecure

Type: bool

Default: false

Ignore TLS certificate validation errors (This is unsafe to use)