Skip to content

HealthchecksPwsh

PowerShell API Platform

📖 Introduction

Healthchecks.io is a free and open-source service for monitoring scheduled jobs (cron, Windows Scheduled Tasks, etc.). It notifies you if your scripts or scheduled tasks do not run on time, providing peace of mind for system administrators and developers.

HealthchecksPwsh is a PowerShell module that provides a modern, user-friendly interface to the Healthchecks v3 API, supporting both healthchecks.io and self-hosted instances. It enables you to manage checks, integrations, badges, and send pings directly from PowerShell.

✨ Features

  • 🚦 Full coverage of Healthchecks v3 Management and Ping APIs
  • 📝 Create, update, pause, resume, and delete checks
  • 📊 List pings, get ping body, and view status flips
  • 🔗 Manage integrations (channels) and project badges
  • 📡 Send pings (success, start, fail, log, exit status) by UUID or slug
  • 🛡️ Robust error handling and output as PSCustomObject
  • 🧩 Consistent User-Agent and parameter validation
  • 📚 Comment-based help for every function
  • 🌍 Works with both healthchecks.io and self-hosted servers

API Key Required

You must have a valid Healthchecks API key and base URL to use most cmdlets. See the Healthchecks API docs for details.

🚀 Quick Start

  1. Install the module from PowerShell Gallery:
Install-PSResource -Name HealthchecksPwsh -Repository PSGallery -Scope CurrentUser
# or, for older PowerShell versions:
# Install-Module -Name HealthchecksPwsh -Repository PSGallery -Scope CurrentUser
  1. List all checks:
Get-Check -ApiKey $apiKey -BaseUrl "https://checks.example.com"
  1. Send a success ping:
Send-Check -UUID "<uuid>" -BaseUrl "https://checks.example.com"
  1. Create a new check:
New-Check -ApiKey $apiKey -BaseUrl "https://checks.example.com" -Name "Backup Job" -Tags "prod" -Timeout 3600 -Grace 300

Get Help for Any Cmdlet

Send-Check or Manage your checks or read about the full list of functions