API Reference
API v2 (Current Version)
Account & System
Health Check

Health Check

Check the health status of the API service.

Endpoint

GET /health

Description

Check the health status of the API service. This endpoint returns the current status, service name, and version information.

Headers

No authentication required.

Example Request

curl https://api.translateplus.io/health

Success Response (200 OK)

When the service is healthy:

{
  "status": "ok",
  "service": "translateplus-api",
  "version": "2.0.0"
}

Response Fields

FieldTypeDescription
statusstringService status: "ok" when healthy, "error" when there are issues
servicestringService identifier: "translateplus-api"
versionstringAPI version number: "2.0.0"

Error Response (503 Service Unavailable)

When the service encounters issues:

{
  "status": "error",
  "service": "translateplus-api",
  "version": "2.0.0"
}

Status Codes

Status CodeDescription
200Service is healthy. Response contains status: "ok"
503Service has issues. Response contains status: "error"

Use Cases

  • Monitoring and alerting systems
  • Load balancer health checks
  • Service availability verification
  • Automated deployment health verification