View Source Circlex.Api.Health (Circlex v0.1.5)

API Client to the Health API.

Reference: https://developers.circle.com/reference/ping

Link to this section Summary

Functions

Pings a server to check connectivity.

Link to this section Functions

Pings a server to check connectivity.

Reference: https://developers.circle.com/reference/ping

examples

Examples

iex> host = Circlex.Test.start_server()
iex> Circlex.Api.Health.ping(host: host)
{:ok, %{message: "pong"}}