// IPSonic MONITORING TOOLKIT / DOCUMENTATION
ipsonic-probe rainbow unicorn

ipsonic-probe ✦

YAML-driven infrastructure validation. Platform-agnostic checks. Zero cloud dependencies.

DNSTCPHTTP / TLSYAML CONFIGCLI FIRSTKISSOFFLINE READY

Part of the ipsonic project ↗ Visit the main website

Production API Health

41-monitoring-text.yaml

HTTP(S)

What this example does

Monitoring integration: Production API Health. Shows how to report checks to existing operational monitoring.

Checks and behavior

  • Sends an GET request to https://api.example.invalid/health.
  • Checks allowed/denied HTTP status codes.
  • Validates required, forbidden or matching HTTP headers.
  • Looks for expected response content and/or rejects known error markers.
  • TLS settings cover certificate trust.
  • Applies response-time thresholds for operational alerting.
  • Formats results for text output.

Adapt example domains, addresses, credentials and thresholds to your environment before use.

YAML configuration

Download original YAML

# Copyright (c) 2026 mati peterson. Maintainer: mati peterson <ipsonic@mailbox.org>. Project: https://ipsonic.com/probe/. Disclaimer: Provided AS IS, without warranty of any kind. Use at your own risk; validate checks and configurations before production use.
name: "Production API Health"
url: "https://api.example.invalid/health"
request:
  method: GET
timeouts:
  connect: 3
  response: 10
tls:
  verify: true
tests:
  status:
    allow: [200]
  headers:
    exists: [Content-Type]
  body:
    not_contains: ["traceback", "internal error"]
monitoring:
  service_name: "API Health"
  output: text
  thresholds:
    response_time:
      warning: 2
      critical: 5