GET

/Common/HealthCheck

When to Use

Verify that the 7G API service is operational and responsive
Implement automated monitoring and alerting systems
Perform health checks before executing critical business operations
Diagnose connectivity issues between your application and the API

Common Scenarios

System Monitoring: Implement automated health checks in monitoring systems and alerting
Load Balancer Checks: Configure load balancers to use this endpoint for service availability
Pre-Transaction Validation: Verify API availability before critical business operations
Connectivity Testing: Diagnose network and configuration issues during development
Uptime Monitoring: Track API availability metrics and service reliability

Prerequisites

No authentication required - this endpoint is publicly accessible
Basic HTTP client capability to make GET requests
Understanding that this only checks API availability, not data integrity

Considerations

This endpoint only confirms the API service is responding to requests
A successful response doesn't guarantee all API functionality is working
Use for basic connectivity testing and automated monitoring
Response time can indicate API performance under current load
Consider implementing retry logic for transient network issues
Suitable for load balancer health checks and uptime monitoring

Description

Provides a simple health check endpoint that returns a positive response to confirm the 7G API service is alive and responsive. This lightweight endpoint is designed for monitoring systems, automated health checks, and basic connectivity verification. It requires no authentication and returns minimal data to ensure fast response times suitable for frequent polling by monitoring tools.

Health Check Use Cases

This endpoint is commonly used for:

Monitoring Systems: Automated uptime monitoring and alerting
Load Balancers: Service availability verification for traffic routing
Application Startup: Confirming API connectivity during initialization
Performance Testing: Baseline response time measurement

⚠️ Important: Limited Scope

This health check only verifies that the API service is responding. It does not validate authentication, database connectivity, or the functionality of specific business endpoints.

Required Headers

No Authorization Header Required - This endpoint is publicly accessible without authentication.

Header	Value	Description
Version	2.0	API version identifier

Query Parameters

This endpoint accepts no query parameters.

Example Requests

bash

# Simple health check
curl -X GET "https://api.7g.com.au/Common/HealthCheck" \
  -H "Version: 2.0"

# Health check with timeout (5 seconds)
curl -X GET "https://api.7g.com.au/Common/HealthCheck" \
  -H "Version: 2.0" \
  --max-time 5

# Health check with response time measurement
time curl -X GET "https://api.7g.com.au/Common/HealthCheck" \
  -H "Version: 2.0" \
  -w "\\nResponse time: %{time_total}s\\n"

Response Examples

json

{
  "result": true,
  "message": "Healthy",
  "data": "2025-01-30T14:23:45.1234567+10:00"
}