Health

Liveness and API-key checks. GET /health/ is public and safe for load-balancer probes; GET /health/auth additionally validates your bearer token.

Public health check

Liveness + database connectivity. No auth required — safe for load-balancer probes.

Response Body

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

fetch("https://example.com/health/")

package main

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

func main() {
  url := "https://example.com/health/"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/health/"

response = requests.request("GET", url)

print(response.text)

Empty

Authenticated health check

Same as /health but requires a valid BARRELMAN_API_KEY bearer token. Use this to verify both reachability and API-key correctness from a client integration.

Response Body

curl -X GET "https://example.com/health/auth"

fetch("https://example.com/health/auth")

package main

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

func main() {
  url := "https://example.com/health/auth"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://example.com/health/auth"

response = requests.request("GET", url)

print(response.text)

Empty