API reference

Service endpoints

Endpoints with no authentication for monitoring.

Check the service is up

GET/healthz

Answers on both hosts without authentication.

Auth: None
Host: Portal origin or API host

Response 200

Successful Response

Field	Type	Notes
`status` required	string	One of `ok`

cURL

curl "$CORRCONNECT_BASE/healthz"

JavaScript

const response = await fetch(`${process.env.CORRCONNECT_BASE}/healthz`);
console.log(response.status, await response.json());

Python

import os

import requests

response = requests.get(
    f"{os.environ['CORRCONNECT_BASE']}/healthz",
    timeout=10,
)
print(response.status_code, response.json())

Swift

import Foundation

let env = ProcessInfo.processInfo.environment
var request = URLRequest(url: URL(string: "\(env["CORRCONNECT_BASE"]!)/healthz")!)
let (data, response) = try await URLSession.shared.data(for: request)
print((response as! HTTPURLResponse).statusCode, String(decoding: data, as: UTF8.self))

Response 200

{
  "status": "ok"
}