iris_alerts data source

blackstork/iris, v0.4.2

Description

Retrieve alerts from Iris API

Installation

To use the iris_alerts data source locally via blackstork-cli, you must declare the blackstork/iris plugin as a dependency in your global configuration block.

blackstork {
  plugin_versions = {
    "blackstork/iris" = ">= v0.4.2"
  }
}

After declaring the dependency, execute blackstork-cli install to fetch the plugin. See Configuration for details.

Configuration

This data source accepts the following configuration arguments within a config data iris_alerts block:

config data iris_alerts {
  # Iris API url
  #
  # Required string.
  # Must be non-empty
  #
  # For example:
  api_url = "some string"

  # Iris API Key
  #
  # Required string.
  # Must be non-empty
  #
  # For example:
  api_key = "some string"

  # Enable/disable insecure TLS
  #
  # Optional bool.
  # Default value:
  insecure = false
}

Usage

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

data iris_alerts {
  # List of Alert IDs
  #
  # Optional list of number.
  # Default value:
  alert_ids = null

  # Alert Source
  #
  # Optional string.
  # Default value:
  alert_source = null

  # List of tags
  #
  # Optional list of string.
  # Default value:
  tags = null

  # Case ID
  #
  # Optional number.
  # Default value:
  case_id = null

  # Alert Customer ID
  #
  # Optional number.
  # Default value:
  customer_id = null

  # Alert Owner ID
  #
  # Optional number.
  # Default value:
  owner_id = null

  # Alert Severity ID
  #
  # Optional number.
  # Default value:
  severity_id = null

  # Alert Classification ID
  #
  # Optional number.
  # Default value:
  classification_id = null

  # Alert State ID
  #
  # Optional number.
  # Default value:
  status_id = null

  # Alert Date - lower boundary
  #
  # Optional string.
  # Default value:
  alert_start_date = null

  # Alert Date - higher boundary
  #
  # Optional string.
  # Default value:
  alert_end_date = null

  # Sort order
  #
  # Optional string.
  # Must be one of: "desc", "asc"
  # Default value:
  sort = "desc"

  # Size limit to retrieve
  #
  # Optional number.
  # Must be >= 0
  # Default value:
  size = 0
}