http data source

blackstork/builtin, v1.0.0

Description #

Sends an HTTP request and returns the response body as template data.

The response format is inferred from the Content-Type header unless format is set. Supported structured formats are decoded into lists, objects, or scalar values. Other responses are returned as plain text.

The http data source is built into the BlackStork engine. It is available out-of-the-box and requires no installation or dependency declaration.

Configuration #

This data source does not accept any configuration arguments.

Usage #

This data source accepts the following arguments within a data http block:

data http {
  # Basic authentication credentials to be used for HTTP request.
  #
  # Optional
  basic_auth {
    # Required string.
    #
    # For example:
    username = "user@example.com"

    # Note: avoid storing credentials in the templates. Use environment variables instead.
    #
    # Required string.
    #
    # For example:
    password = "passwd"
  }


  # URL to fetch data from. Supported schemas are `http` and `https`
  #
  # Required string.
  # Must be non-empty
  #
  # For example:
  url = "https://example.localhost/file.json"

  # HTTP method for the request. Allowed methods are `GET`, `POST` and `HEAD`
  #
  # Optional string.
  # Must be one of: "GET", "POST", "HEAD"
  # Default value:
  method = "GET"

  # If set to `true`, disabled verification of the server's certificate.
  #
  # Optional bool.
  # Default value:
  insecure = false

  # The duration of a timeout for a request. Accepts numbers, with optional fractions and a unit suffix. For example, valid values would be: 1.5s, 30s, 2m, 2m30s, or 1h
  #
  # Optional string.
  # Default value:
  timeout = "30s"

  # The headers to be set in a request
  #
  # Optional map of string.
  # Default value:
  headers = null

  # Request body
  #
  # Optional string.
  # Default value:
  body = null

  # Response format. If omitted, the format is inferred from the response Content-Type header.
  #
  # Optional string.
  # Must be one of: "json", "yaml", "csv", "text", null
  # Default value:
  format = null
}