Skip to main content
Version: 3.3.0

http-get

Run HTTP GET requests

Field NameDescriptionTypeDefault
batchMaximum number of events in an output batch. If 'document' send on end of documentinteger or the 'document'-
timeoutInterval after which the batch is sent, to keep throughput goinginterval100ms
headerPut a header line before the batchtemplated text-
footerPut a header line after the last line of the batchtemplated text-
use-document-markerEnrich the pipe metadata with a document marker (for document handling in batch mode)boolfalse
urlConnect to this addressurl-
body-fieldA field containing the bodyfield-
headersHeaders to send with the queryarray of maps-
retryFor operations that could potentially failRetry-
insecureIgnore TLS certificate validation errors (This is unsafe to use)boolfalse

batch

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

Type: integer or the 'document'

timeout

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

Type: interval

Put a header line before the batch

Type: templated text

Put a header line after the last line of the batch

Type: templated text

use-document-marker

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

Type: bool

url

Connect to this address

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

Type: url

body-field

A field containing the body

Type: field

Example

action:

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

headers

Headers to send with the query

Type: array of maps

Example

action:

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

retry

For operations that could potentially fail

Type: Retry

Field NameDescriptionTypeDefault
countHow many attempts to make before declaring failureinteger-
pauseHow long to pause before re-tryingduration-
foreverKeep trying until success is declaredboolfalse

count

How many attempts to make before declaring failure

Type: integer

Example

action:

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

output:

{"_raw":"one two"}

pause

How long to pause before re-trying

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

Type: duration

Example

action:

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

output:

{"_raw":"one two"}

forever

Keep trying until success is declared

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

Type: bool

Example

action:

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

output:

{"_raw":"one two"}

insecure

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

Type: bool