Api Health Check (api-health-check)

Summary

Configurable HTTP health check for an API endpoint.

Classification

• Category: API_HEALTH
• Plugin id: api-health-check
• Version: 1.0.0
• Target types: API
• Weight class: LIGHT
• Risk level: not set on plugin object
• Browser required: No (HTTP / Node / other — see source)
• Tier / group: Tier 4 — API

Schedule

• scheduleHints: { defaultInterval: '0 */1 * * *', priority: 9 }
• Prerequisites: None declared on this plugin.

Configurable inputs

Public keys are derived from inputSchema: z.object({ ... }) (underscore-prefixed keys are runtime-only and omitted here).

Field	Notes
url	Zod field in inputSchema — see source for defaults, min/max, and .describe().
method	Zod field in inputSchema — see source for defaults, min/max, and .describe().
headers	Zod field in inputSchema — see source for defaults, min/max, and .describe().
body	Zod field in inputSchema — see source for defaults, min/max, and .describe().
auth	Zod field in inputSchema — see source for defaults, min/max, and .describe().
type	Zod field in inputSchema — see source for defaults, min/max, and .describe().
token	Zod field in inputSchema — see source for defaults, min/max, and .describe().
username	Zod field in inputSchema — see source for defaults, min/max, and .describe().
password	Zod field in inputSchema — see source for defaults, min/max, and .describe().
headerName	Zod field in inputSchema — see source for defaults, min/max, and .describe().
expectedStatus	Zod field in inputSchema — see source for defaults, min/max, and .describe().
expectedBody	Zod field in inputSchema — see source for defaults, min/max, and .describe().
timeout	Zod field in inputSchema — see source for defaults, min/max, and .describe().

Runtime / injected config

• None documented beyond standard worker context (target, config, logger, reportProgress). Underscore-prefixed keys are internal.

What it does

• Runs as part of the worker test execution pipeline; results become Run rows and may create Finding records.
• Configurable HTTP health check for an API endpoint.
• For finding titles, metrics, and artifacts specific to this plugin, refer to the implementation linked below.

Source

packages/test-plugins/src/plugins/api-health-check.ts