Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/GingerlyData247/SOTeam4-P2/llms.txt

Use this file to discover all available pages before exploring further.

Returns the current health status of the Model Registry system, including uptime and activity metrics.

​
Endpoint

GET /health

​
Description

The health endpoint provides a quick way to verify that the Model Registry API is running and responsive. It returns system uptime information and the current count of registered models, making it useful for monitoring and health checks.

​
Response Format

The endpoint returns a JSON object with the following fields:
  • status (string): System status indicator, returns “ok” when the service is healthy
  • uptime_s (integer): Number of seconds the service has been running since last restart
  • models (integer): Total count of models currently registered in the system

​
Response Example

{
  "status": "ok",
  "uptime_s": 3600,
  "models": 42
}

​
Use Cases

​
System Monitoring

Use this endpoint for health checks in monitoring systems, load balancers, or orchestration platforms like Kubernetes.

​
Activity Tracking

The models field provides insight into recent system activity and the number of artifacts currently in the registry.

​
Uptime Information

Track service uptime to monitor stability and identify when the service was last restarted.

​
cURL Example

curl -X GET http://localhost:8080/health

​
Status Codes

  • 200 OK: Service is healthy and responsive

Build docs developers (and LLMs) love

Get started for freeTalk to us