HTTP JSON inputedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Use the httpjson input to read messages from an HTTP API with JSON payloads.

For example, this input is used to retrieve MISP threat indicators in the filebeat x-pack misp module.

This input supports timed retrieval at a configurable interval and pagination.

Example configurations:

filebeat.inputs:
- type: httpjson
  api_key: <YOUR API KEY>
  interval: 12h
  url: <URL to access>
filebeat.inputs:
- type: httpjson
  http_method: POST
  json_objects_array: hits.hits
  pagination: |-
  {
    "enabled": true,
    "extra_body_content": {
      "scroll": "5m"
    },
    "id_field": "_scroll_id",
    "req_field": "scroll_id",
    "url": "http://localhost:9200/_search/scroll"
   }
   url: http://localhost:9200/filebeat-test/_search?scroll=5m

Configuration optionsedit

The httpjson input supports the following configuration options plus the Common options described later.

api_keyedit

API key to access the HTTP API. Optional. Default: "", which means no API key is used.

http_client_timeoutedit

Time duration before declaring that the HTTP client connection has timed out. Default: 60s.

http_headersedit

Extra HTTP header options can be set by specifying this JSON object. Default: not used.

http_methodedit

This option specifies which HTTP method to use, GET or POST. Default: GET.

http_request_bodyedit

Any additional data that needs to be set in the HTTP request can be specified in this JSON blob. Default: not used.

intervaledit

Time duration between repeated data retrievals. Default: 0s, meaning no repeated data retrieval.

json_objects_arrayedit

If the HTTP API returns data in a JSON array, then this option can be set to decode these records from the array. Default: not used.

no_http_bodyedit

If set, do not use HTTP request body. Default: false.

pagination.enablededit

This option specifies whether pagination is enabled. Default: true.

pagination.extra_body_contentedit

Any additional data that needs to be set in the HTTP pagination request can be specified in this JSON blob. Default: not used.

pagination.header.field_nameedit

The field name in the HTTP Header that is used for pagination control.

pagination.header.regex_patternedit

The regular expression pattern to use for retrieving the pagination information from the HTTP Header field specified above.

pagination.id_fieldedit

This specifies which field to use as the pagination id, to retrieve the id from the pagination result JSON document. Required when pagination is enabled.

pagination.req_fieldedit

This specifies which field to use as the pagination request id, to send to the HTTP API. Required when pagination is enabled.

pagination.urledit

This specifies the URL for sending pagination request. Required if the pagination URL is different than the HTTP API URL.

rate_limit.limitedit

This specifies the field in the HTTP Header of the response that specifies the total limit.

rate_limit.remainingedit

This specifies the field in the HTTP Header of the response that specifies the remaining quota of the rate limit.

rate_limit.resetedit

This specifies the field in the HTTP Header of the response that specifies the epoch time when the rate limit will be reset.

ssledit

This specifies SSL/TLS common config. Default: not used.

urledit

The URL of the HTTP API. Required.

Common optionsedit

The following configuration options are supported by all inputs.

enablededit

Use the enabled option to enable and disable inputs. By default, enabled is set to true.

tagsedit

A list of tags that Filebeat includes in the tags field of each published event. Tags make it easy to select specific events in Kibana or apply conditional filtering in Logstash. These tags will be appended to the list of tags specified in the general configuration.

Example:

filebeat.inputs:
- type: httpjson
  . . .
  tags: ["json"]
fieldsedit

Optional fields that you can specify to add additional information to the output. For example, you might add fields that you can use for filtering log data. Fields can be scalar values, arrays, dictionaries, or any nested combination of these. By default, the fields that you specify here will be grouped under a fields sub-dictionary in the output document. To store the custom fields as top-level fields, set the fields_under_root option to true. If a duplicate field is declared in the general configuration, then its value will be overwritten by the value declared here.

filebeat.inputs:
- type: httpjson
  . . .
  fields:
    app_id: query_engine_12
fields_under_rootedit

If this option is set to true, the custom fields are stored as top-level fields in the output document instead of being grouped under a fields sub-dictionary. If the custom field names conflict with other field names added by Filebeat, then the custom fields overwrite the other fields.

processorsedit

A list of processors to apply to the input data.

See Processors for information about specifying processors in your config.

pipelineedit

The Ingest Node pipeline ID to set for the events generated by this input.

The pipeline ID can also be configured in the Elasticsearch output, but this option usually results in simpler configuration files. If the pipeline is configured both in the input and output, the option from the input is used.

keep_nulledit

If this option is set to true, fields with null values will be published in the output document. By default, keep_null is set to false.

indexedit

If present, this formatted string overrides the index for events from this input (for elasticsearch outputs), or sets the raw_index field of the event’s metadata (for other outputs). This string can only refer to the agent name and version and the event timestamp; for access to dynamic fields, use output.elasticsearch.index or a processor.

Example value: "%{[agent.name]}-myindex-%{+yyyy.MM.dd}" might expand to "filebeat-myindex-2019.11.01".