Liveness probe

GET

/health

const url = 'https://api.sulpayments.ch/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.sulpayments.ch/health

/health, not /healthz: Google Frontend reserves the latter on run.app domains.

Responses

200

Service is up

application/json

Liveness answer for load balancers and uptime checks.

object

service

required

string

status

required

Always "ok" when the service is able to answer.

string

version

required

string

Example

{
  "service": "api",
  "status": "ok",
  "version": "0.2.0"
}