Uptimeify Docs
Resources

uptimeify_report

A scheduled fleet report of the organization (mail, optionally with PDF). Unset optional attributes take the server default on create and keep their value afterwards. Import with the report id (UUID).

A scheduled fleet report of the organization (mail, optionally with PDF). Unset optional attributes take the server default on create and keep their value afterwards. Import with the report id (UUID).

Example Usage

resource "uptimeify_report" "weekly" {
  name             = "Weekly fleet report"
  frequency        = "weekly"
  weekday          = 1
  send_hour        = 7
  format           = "email_pdf"
  recipient_emails = ["ops@example.com"]
}

Schema

Required

  • name (String)

Optional

  • day_of_month (Number) 1-28. Required for monthly reports.
  • enabled (Boolean) Default true.
  • format (String) email or email_pdf (default).
  • frequency (String) daily, weekly or monthly (default). Weekly needs weekday, monthly needs day_of_month.
  • group_by_customer (Boolean) Group by customer. Default false.
  • inclusion_mode (String) all (default), problems or threshold.
  • monitor_types (List of String) Monitor types in the report (default: all ten).
  • problem_signals (Attributes) What counts as a problem for inclusion_mode = "problems". (see below for nested schema)
  • recipient_emails (List of String)
  • recipient_user_ids (List of String) Logins of the organization (uptimeify_user.id).
  • scope_customer_ids (List of Number) Customers for scope_mode = "customers".
  • scope_mode (String) all (default), customers or tags.
  • scope_tag_ids (List of Number) Tags for scope_mode = "tags".
  • sections (Attributes) Report sections (default: all on except group_by_customer). (see below for nested schema)
  • sections_by_type (Map of Map of Boolean) Per monitor type section switches, e.g. { website = { sslExpiry = false } } (server-side key names).
  • send_hour (Number) Hour of day 0-23 in timezone. Default 2.
  • send_when_empty (Boolean) Send even when nothing qualifies. Default false.
  • threshold_response_gt (Number) Response time in ms for inclusion_mode = "threshold".
  • threshold_uptime_lt (Number) Uptime percentage for inclusion_mode = "threshold".
  • timezone (String) IANA time zone. Default Europe/Berlin.
  • weekday (Number) 0-6, 0 = Sunday. Required for weekly reports.

Read-Only

  • created_at (String)
  • id (String) Report id (UUID).

Nested Schema for problem_signals

Required:

  • incident (Boolean)
  • response_breach (Boolean)

Optional:

  • downtime_minutes (Number)
  • ssl_days_lt (Number)

Nested Schema for sections

Required:

  • fleet_summary (Boolean)
  • group_by_customer (Boolean)
  • incident_log (Boolean)
  • per_site_table (Boolean)
  • ssl_expiry (Boolean)
  • worst_performers (Boolean)

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

# Report id (UUID)
terraform import uptimeify_report.weekly 0b5f7a3e-1c2d-4e5f-8a9b-0c1d2e3f4a5b

On this page