Health check

client.Health.Check(ctx) (*HealthCheckResponse, error)

get/health

Health check

ReturnsExpand Collapse

type HealthCheckResponse struct{…}

Status HealthCheckResponseStatus

Accepts one of the following:

const HealthCheckResponseStatusOk HealthCheckResponseStatus = "ok"

Health check

package main

import (
  "context"
  "fmt"

  "github.com/onkernel/hypeman-go"
  "github.com/onkernel/hypeman-go/option"
)

func main() {
  client := hypeman.NewClient(
    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"
}