Skip to main content
GET
/
health
Health check
curl --request GET \
  --url https://api-v2.polyrouter.io/health \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api-v2.polyrouter.io/health"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-v2.polyrouter.io/health', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api-v2.polyrouter.io/health"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "data": {
    "status": "healthy",
    "checks": [
      {
        "name": "database",
        "status": "pass",
        "response_time_ms": 15
      }
    ],
    "uptime": 86400,
    "version": "2.0.0",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_time": 50
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Response

200 - application/json

API is healthy

data
object
required
meta
object
required