Skip to main content
GET

Health Check

The health endpoint provides a simple way to check if the Submagic API is operational. This endpoint does not require authentication and can be used for monitoring and health checks.
This endpoint does not require authentication and is not subject to rate limiting.

Request

void
This endpoint does not accept any parameters.

Response

string
The current status of the API service
string
The name of the service
string
ISO 8601 timestamp of when the response was generated

Use Cases

Uptime Monitoring

Use this endpoint to monitor API availability in your monitoring systems

Load Balancer Health Checks

Configure your load balancer to use this endpoint for health checks

CI/CD Pipeline Validation

Verify API availability before running integration tests

Status Page Integration

Include this endpoint in your status page monitoring

Status Values

Example Monitoring Script

Here’s a simple monitoring script you can use:
The health endpoint is designed to respond quickly (typically under 100ms) to provide fast health check results for monitoring systems.