Skip to content
DashboardGet API Key

Health check

client.Health.Check(ctx) (*HealthCheckResponse, error)
GET/health

Returns HTTP 200 when the service is running. No authentication required.

ReturnsExpand Collapse
type HealthCheckResponse struct{…}
Status HealthCheckResponseStatus

Health check

package main

import (
  "context"
  "fmt"

  "github.com/chamelaion/chamelaion-go"
  "github.com/chamelaion/chamelaion-go/option"
)

func main() {
  client := chamelaion.NewClient(
    option.WithBearerToken("My Bearer Token"),
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Health.Check(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Status)
}
{
  "status": "ok"
}
Returns Examples
{
  "status": "ok"
}