Skip to Content
Uptimeify Docs
Resources

uptimeify_package_config

One package of the organization, addressed by its package_type (PATCH /api/package-configs/{packageType}). Manages the limits only: monitors, status pages and self-service per customer of the package. The check and alert defaults of the package stay as they are (the server's defaults for a new package); read them with data.uptimeify_package_configs. Its enable_*_alerts switches govern only the organization's notifications about the package's customers (organization channels and the organization recipient of the email/SMS fallback), never channels a customer created in their own account; a customer's own enable_*_alerts value replaces them for that customer. SMS through a customer's own channels still counts against the package's monthly SMS limit per customer and the organization's overage limit (0 while the package SMS switch is off and no limit is set). If the package already exists, creating the resource adopts it. Destroy deletes the package and fails (packageInUse) while customers use it. Import with the package type.

One package of the organization, addressed by its package_type (PATCH /api/package-configs/{packageType}). Manages the limits only: monitors, status pages and self-service per customer of the package. The check and alert defaults of the package stay as they are (the server's defaults for a new package); read them with data.uptimeify_package_configs. Its enable_*_alerts switches govern only the organization's notifications about the package's customers (organization channels and the organization recipient of the email/SMS fallback), never channels a customer created in their own account; a customer's own enable_*_alerts value replaces them for that customer. SMS through a customer's own channels still counts against the package's monthly SMS limit per customer and the organization's overage limit (0 while the package SMS switch is off and no limit is set). If the package already exists, creating the resource adopts it. Destroy deletes the package and fails (packageInUse) while customers use it. Import with the package type.

Example Usage

resource "uptimeify_package_config" "business" {
  package_type       = "business"
  display_name       = "Business"
  max_urls           = 50
  max_status_pages   = 3 # unset = unlimited
  allow_self_service = true
}

Schema

Required

  • package_type (String) Package key, 1 to 64 characters, no surrounding whitespace, e.g. essential. Changing it replaces the package.

Optional

  • allow_self_service (Boolean) Customers of the package may create their own (self_service) monitors and status pages. Unset = kept as is.
  • display_name (String) Name shown in the UI, 1 to 64 characters. Unset = kept as is.
  • max_self_service_urls (Number) Self-service monitors per customer. Unset = kept as is.
  • max_status_pages (Number) Status pages per customer of this package. Unset = unlimited. Pages without a customer never count.
  • max_urls (Number) Monitors per customer. Unset = kept as is (a new package uses the default of its type).
  • notes (String) Internal notes, up to 4096 characters. Unset = kept as is (the API cannot clear them).

Read-Only

  • id (String) Same as package_type.

Import

Import is supported using the following syntax:

The terraform import command can be used, for example:

# Package type
terraform import uptimeify_package_config.business business

On this page