Page Introduction

health-endpoint namespace

This namespace page documents shared/core contracts used across domains, with examples for direct frontend and service integration.

Review auth and method details before service integration.
Use endpoint cards for request/response contract checks.
Validate behavior against selected runtime environment.

Choose next step

Back to Core index Open Core try-it Open all Core endpoints

Core/Common Namespace

Health Endpoint

Namespace details with request/response examples and code snippets.

2Endpoint methods

Test in Core Try-It OpenAPI JSON

Endpoint Quick Index

GET /api/co/realtime/config GET /api/core/healthz

Detailed Endpoints

GET/api/co/realtime/config

Endpoint operation.

Returns Supabase Realtime connection config and channel names for the authenticated user.

Auth: Bearer token (`Authorization: Bearer <token>`)Source: CORE-COMMON-API-COMPLETE.md

Request Example

{}

Response Example

{
  "supabase_url": "string_value",
  "anon_key": "string_value",
  "channels": {},
  "enabled": true
}

Node.js Axios example

import axios from "axios";

const BASE_URL = process.env.MINBIL_API_BASE_URL ?? "http://localhost:5000";
const API_KEY = process.env.MINBIL_API_KEY ?? "YOUR_API_KEY";
const ACCESS_TOKEN = process.env.MINBIL_ACCESS_TOKEN ?? "YOUR_BEARER_TOKEN";

async function run() {
  const response = await axios({
    method: "get",
    url: BASE_URL + "/api/co/realtime/config",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer " + ACCESS_TOKEN,
    },
    timeout: 20000,
  });
  console.log(response.status, response.data);
}

run().catch((error) => {
  console.error(error.response?.status, error.response?.data ?? error.message);
});

cURL example

curl -X GET 'https://api.minbil.no/api/co/realtime/config'\
  -H 'Accept: application/json'\
  -H 'Authorization: Bearer <access-token>'

Fetch example

const BASE_URL = process.env.MINBIL_API_BASE_URL ?? "http://localhost:5000";
const API_KEY = process.env.MINBIL_API_KEY ?? "YOUR_API_KEY";
const ACCESS_TOKEN = process.env.MINBIL_ACCESS_TOKEN ?? "YOUR_BEARER_TOKEN";

const response = await fetch(BASE_URL + "/api/co/realtime/config", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer " + ACCESS_TOKEN,
  },
});
const data = await response.json();
console.log(response.status, data);

GET/api/core/healthz

Health check for API service availability.

Auth: None (public endpoint).Source: CORE-COMMON-API-COMPLETE.md

Request Example

{}

Response Example

{
  "status": "ok",
  "time": "2026-02-16T10:00:00Z",
  "client_ip": "127.0.0.1"
}

Node.js Axios example

import axios from "axios";

const BASE_URL = process.env.MINBIL_API_BASE_URL ?? "http://localhost:5000";
const API_KEY = process.env.MINBIL_API_KEY ?? "YOUR_API_KEY";
const ACCESS_TOKEN = process.env.MINBIL_ACCESS_TOKEN ?? "YOUR_BEARER_TOKEN";

async function run() {
  const response = await axios({
    method: "get",
    url: BASE_URL + "/api/core/healthz",
    headers: {
      "Content-Type": "application/json",
    },
    timeout: 20000,
  });
  console.log(response.status, response.data);
}

run().catch((error) => {
  console.error(error.response?.status, error.response?.data ?? error.message);
});

cURL example

curl -X GET 'https://api.minbil.no/healthz' \
  -H 'Accept: application/json'

Fetch example

const BASE_URL = process.env.MINBIL_API_BASE_URL ?? "http://localhost:5000";
const API_KEY = process.env.MINBIL_API_KEY ?? "YOUR_API_KEY";
const ACCESS_TOKEN = process.env.MINBIL_ACCESS_TOKEN ?? "YOUR_BEARER_TOKEN";

const response = await fetch(BASE_URL + "/api/core/healthz", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
  },
});
const data = await response.json();
console.log(response.status, data);