Skip to content

Python Health Functions

Akshay B edited this page Mar 16, 2026 · 1 revision

Python Health Functions (Azure Functions)

This document details health availability routes in PluckIt.Processor.

Documentation metadata

  • Audience: external contributors
  • Last reviewed: 2026-03-16
  • Scope: health contract only

Endpoint contracts

HealthFunctions

  • GET /api/health
    • Public availability endpoint
    • Returns basic health response for service liveness checks
    • Expected to remain lightweight and fast for orchestration / monitoring callers

Response semantics

  • Success shape is a minimal, non-PII health payload that indicates service readiness for external callers.

Notes

  • This endpoint is intentionally lightweight and does not require bearer authentication.
  • In production monitoring, this is the preferred first-level liveness probe before deeper workflow checks.

Clone this wiki locally