Skip to main content
GET
/
api
/
health
curl -X GET "https://api.mailgreet.com/api/health"

{
  "status": "ok",
  "message": "MailGreet Laravel API is running",
  "timestamp": "2026-01-18T14:00:00Z",
  "version": "1.0.0"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mailgreet.com/llms.txt

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

​
Overview

Check if the MailGreet API is running and available. This endpoint is public and does not require authentication, making it ideal for uptime monitoring and health checks.
This is the only endpoint that doesn’t require an API key. Use it for monitoring services like UptimeRobot, Pingdom, or custom health checks.

​
Authentication

No authentication required. This endpoint is publicly accessible.

​
Base URL

This endpoint uses a different base URL than other API endpoints: 
https://api.mailgreet.com/api/health

​
Response

​
status
string
API status: ok when healthy
​
message
string
Status message confirming the API is running
​
timestamp
string
ISO 8601 timestamp of the health check
​
version
string
Current API version
curl -X GET "https://api.mailgreet.com/api/health"

{
  "status": "ok",
  "message": "MailGreet Laravel API is running",
  "timestamp": "2026-01-18T14:00:00Z",
  "version": "1.0.0"
}

​
Use Cases

Uptime Monitoring

Configure your monitoring service to ping this endpoint every minute

Load Balancer

Use as a health check endpoint for your load balancer configuration

Status Page

Integrate with your status page to show API availability

CI/CD Pipeline

Check API availability before running integration tests

​
Monitoring Setup Examples

​
UptimeRobot

URL: https://api.mailgreet.com/api/health
Method: GET
Expected Status: 200
Check Interval: 60 seconds

​
Pingdom

Check Type: HTTP
URL: https://api.mailgreet.com/api/health
Response should contain: "status": "ok"