skills.rest
bytetalent
bytetalentOFFICIAL
Explore all skills by this author →
GitHub

API Health Check

Verify database connectivity via a standard API health check endpoint.

Updated Apr 30, 2026
Search Tags:#uptime monitoring#database connectivity#api health check#post-deploy checks#status endpoint
One-click install
npx skills add https://github.com/bytetalent/docs --skill api-health-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: API Health Check
Source: https://github.com/bytetalent/docs/tree/main/skills/api/api-healthcheck
Command: npx skills add https://github.com/bytetalent/docs --skill api-health-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the need for a consistent, lightweight health check endpoint in Bytetalent projects to verify database connectivity and status, which is crucial for uptime monitoring and post-deploy smoke checks.

Core Features & Use Cases

  • Database Connectivity Verification: Quickly confirm that your database is reachable and functioning correctly.
  • Status Reporting: Provide a simple status of 'ok' or 'degraded' to uptime monitors and load balancers.
  • Use Case: Deploy this Skill as part of your project's infrastructure to ensure that your services are always available, and quickly identify issues that could impact your users.

Quick Start

Implement the API health check by adding the provided route to your project's API routes.

Frequently Asked Questions about API Health Check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add an API health check endpoint to verify Supabase database connectivity?▼

To add an API health check endpoint, implement a lightweight route that probes your Supabase database. It uses drizzle-orm to execute a minimal query, returning an 'ok' or 'degraded' status based on database connectivity.

Does this API health check route work with both Next.js and Expo applications?▼

Yes, this API health check route is applicable to both Next.js and Expo applications. It is specifically designed for Bytetalent projects utilizing Clerk and Supabase to verify database connectivity.

What is a post-deploy smoke check for API status and when do I need it?▼

A post-deploy smoke check is a lightweight verification step needed after deploying updates. It confirms your API's database connectivity is reachable, reporting 'ok' or 'degraded' to uptime monitors to quickly identify deployment issues.

How do I report API status to uptime monitors using a probe endpoint?▼

You report API status to uptime monitors by deploying a probe endpoint that checks database connectivity. It returns a simple 'ok' or 'degraded' status, allowing monitors and load balancers to quickly identify service availability issues.

Why does my API health check return a degraded status?▼

Your API health check returns a 'degraded' status when the minimal database probe fails to verify connectivity. This indicates your Supabase database is unreachable or not functioning correctly, alerting monitors to potential service impacts.

Related Skills

Explore More Software Engineering Skills→
AdigunQAdigunQ

supabase-nextjs

Integrate Next.js with Supabase and Drizzle ORM for type-safe database operations.

Community
Advanced
ricardorochericardoroche
2

monitoring-alerting

Automate Prometheus/Grafana monitoring, alerting, and SLO/SLI definitions.

Community
Intermediate
Fantasia1999Fantasia1999

saas-scaffolder

Generate a Next.js 14+ SaaS boilerplate with authentication, database, billing, and dashboard.

Community
Advanced
spallempatispallempati

health-checks

Configure liveness and readiness health checks for .NET 8+ applications.

Community
Intermediate