http-get
Run HTTP GET requests
Field Name | Description | Type | Default |
---|---|---|---|
batch | Maximum number of events in an output batch. If 'document' send on end of document | integer or the 'document' | - |
timeout | Interval after which the batch is sent, to keep throughput going | interval | 100ms |
header | Put a header line before the batch | templated text | - |
footer | Put a header line after the last line of the batch | templated text | - |
use-document-marker | Enrich the pipe metadata with a document marker (for document handling in batch mode) | bool | false |
url | Connect to this address | url | - |
body-field | A field containing the body | field | - |
headers | Headers to send with the query | array of maps | - |
retry | For operations that could potentially fail | Retry | - |
insecure | Ignore TLS certificate validation errors (This is unsafe to use) | bool | false |
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
header
Put a header line before the batch
Type: templated text
footer
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 Name | Description | Type | Default |
---|---|---|---|
count | How many attempts to make before declaring failure | integer | - |
pause | How long to pause before re-trying | duration | - |
forever | Keep trying until success is declared | bool | false |
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