Health Check

​

Description

• The API server is running
• The MongoDB database connection is active
• Database operations can be performed

​

Authentication

​

Response

​

Status Codes

• 200 OK - API and database are healthy
• 404 Not Found - Database connection failed (includes error details)

​

Request Example

curl -X GET https://api.example.com/health

​

Response Examples

{
  "message": "Database is active"
}

​

Implementation Details

await app.db.command("ping")

• Tests the connection to the database
• Verifies authentication (if required)
• Returns quickly (typically less than 10ms)
• Minimal resource usage

​

Monitoring Best Practices

checks:
  - name: Short URL API Health
    url: https://api.example.com/health
    interval: 60s
    timeout: 10s
    expect_status: 200
    expect_body: "Database is active"

​

Database Connection

• Database: ShortURL
• Collections: URLMap, URLStats
• Connection: Established during app startup via MongoDB Motor (async driver)

​

Related Endpoints

• GET / - Welcome message (minimal check, no database validation)
• GET /validate_token - Check if an access token is valid