Uptimeify Docs
Data Sources

uptimeify_website

Read one website monitor by id. Secrets (headers, body, auth secrets) are never returned.

Read one website monitor by id. Secrets (headers, body, auth secrets) are never returned.

Example Usage

data "uptimeify_website" "api" {
  id = "42"
}

Schema

Required

  • id (String) Numeric id or public id.

Read-Only

  • allowed_check_country_codes (Set of String) Upper-case ISO country codes of the check locations. Unset at create: the package default (null = all). Removing it later keeps the last value.
  • auth_mode (String) none, authorization_header (needs authorization_header_wo) or basic (needs basic_auth_username and basic_auth_password_wo). Defaults to none.
  • basic_auth_username (String) Username for auth_mode = "basic".
  • check_domain_expiry_enabled (Boolean) Domain expiry check. Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • check_expected_response_enabled (Boolean) Compare the response body with expected_response_value. Defaults to false.
  • check_https_redirect_enabled (Boolean) HTTP to HTTPS redirect check. Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • check_interval (Number) Minutes between checks; at least the package minimum, at most 1440 (43200 for heartbeat). Defaults to 30.
  • check_keyword_enabled (Boolean) Keyword check against search_term; off without a search term. Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • check_response_time_enabled (Boolean) Response time check (the threshold is not configurable per monitor). Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • check_size_enabled (Boolean) Page size check against min_page_size/max_page_size; off without a limit. Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • check_ssl_enabled (Boolean) Certificate validity and expiry check. Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • check_status_enabled (Boolean) Status code check against expected_status_codes. Unset: the package default. The package may switch it off; a full update switches it off on heartbeat monitors.
  • connect_host (String) Connect target (connectHost): IP or host name to connect to instead of the URL's host; SNI and Host header stay the URL's. Lower case, without port (use connect_port), must be public.
  • connect_port (Number) Port of the connect target; unset = the URL's port.
  • connect_tls_insecure (Boolean) Skip certificate verification at the connect target; needs connect_host. Defaults to false.
  • cookie_handling (String) none or jar (keep cookies across redirects). Defaults to none.
  • created_at (String)
  • customer_id (Number) Numeric id of the customer that owns the monitor. Changing it moves the monitor.
  • domain_expiry_error_days (Number) Error this many days before domain expiry. Defaults to 7.
  • domain_expiry_notice_days (Number) Warn this many days before domain expiry. Defaults to 30.
  • expected_response_json_path (String)
  • expected_response_match_type (String) contains, equals or json_path_equals (needs expected_response_json_path). Defaults to contains.
  • expected_response_value (String)
  • expected_status_codes (String) Comma-separated accepted status codes. Defaults to 200,301,302.
  • follow_redirects (Boolean) Defaults to true.
  • has_custom_headers (Boolean) Whether custom headers are stored.
  • has_request_body (Boolean) Whether a request body is stored.
  • heartbeat_grace_period_minutes (Number) Heartbeat monitors: minutes a ping may be late. Server default 5; null for other types.
  • heartbeat_token (String, Sensitive) Heartbeat monitors: token of the ping URL (server-generated). Sensitive: anyone with it can report the job as healthy.
  • http_method (String) GET, QUERY, POST, PUT, PATCH, DELETE, HEAD or OPTIONS. Defaults to GET.
  • max_page_size (Number) Bytes; dropped by the server while check_size_enabled is off.
  • min_page_size (Number) Bytes; dropped by the server while check_size_enabled is off.
  • monitoring_type (String) combined, http_status, ssl_check or heartbeat. Changing it replaces the monitor. Defaults to combined.
  • name (String)
  • public_id (String) Public UUID of the website.
  • search_term (String) Keyword the page must contain (needs check_keyword_enabled; the server drops it while that check is off).
  • ssl_error_days (Number) Error this many days before certificate expiry; at most ssl_notice_days. Defaults to 0.
  • ssl_notice_days (Number) Warn this many days before certificate expiry. Defaults to 7.
  • status (String) active, inactive or maintenance. Defaults to active.
  • timeout_seconds (Number) Request timeout, 1 to 60. Defaults to 30.
  • updated_at (String)
  • url (String) URL with protocol; required except for heartbeat monitors. Heartbeat monitors get heartbeat://<monitor id> from the server (the ping token is heartbeat_token), leave it unset there. Must resolve to a public address at create and update.

uptimeify_user

Look up one login of the organization by email (case-insensitive), e.g. for team members and rotations.

On this page

Example UsageSchemaRequiredRead-Only