Health API

Whether the API is up. No key needed.

This page is generated from the OpenAPI specification; the same text is inMarkdown for tools and AI assistants.

Is the API up

GET/healthz

Answers as long as the process is running. Does not touch the database.

Response 200

The API is up.

Fields

Name	Type	Description
statusrequired	string	One of "ok".

cURL

curl "https://api.cardinalstreaming.com/healthz"

Python

import os

import requests

response = requests.get(
    "https://api.cardinalstreaming.com/healthz",
    timeout=30,
)
print(response.status_code, response.text)

JavaScript

const response = await fetch('https://api.cardinalstreaming.com/healthz', {
  method: 'GET',
});
const data = await response.json();
console.log(response.status, data);

TypeScript

const response: Response = await fetch('https://api.cardinalstreaming.com/healthz', {
  method: 'GET',
});
const data: unknown = await response.json();
console.log(response.status, data);

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.cardinalstreaming.com/healthz', [
    'http_errors' => false,
]);
echo $response->getStatusCode(), ' ', $response->getBody(), PHP_EOL;

Ruby

require 'json'
require 'net/http'

uri = URI("https://api.cardinalstreaming.com/healthz")
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, response.body

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.cardinalstreaming.com/healthz", nil)
  if err != nil {
    panic(err)
  }

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  data, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.StatusCode, string(data))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.cardinalstreaming.com/healthz"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

C#

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.cardinalstreaming.com/healthz");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

Response 200

{
  "status": "ok"
}

Is the API ready to serve

GET/readyz

Answers 200 once the API can reach its database, 503 not_ready when it cannot.

Response 200

Ready.

Fields

Name	Type	Description
statusrequired	string	One of "ready".

Errors

Status	Code	Meaning
503	not_ready	The database is unreachable.

cURL

curl "https://api.cardinalstreaming.com/readyz"

Python

import os

import requests

response = requests.get(
    "https://api.cardinalstreaming.com/readyz",
    timeout=30,
)
print(response.status_code, response.text)

JavaScript

const response = await fetch('https://api.cardinalstreaming.com/readyz', {
  method: 'GET',
});
const data = await response.json();
console.log(response.status, data);

TypeScript

const response: Response = await fetch('https://api.cardinalstreaming.com/readyz', {
  method: 'GET',
});
const data: unknown = await response.json();
console.log(response.status, data);

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.cardinalstreaming.com/readyz', [
    'http_errors' => false,
]);
echo $response->getStatusCode(), ' ', $response->getBody(), PHP_EOL;

Ruby

require 'json'
require 'net/http'

uri = URI("https://api.cardinalstreaming.com/readyz")
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, response.body

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, err := http.NewRequest("GET", "https://api.cardinalstreaming.com/readyz", nil)
  if err != nil {
    panic(err)
  }

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  data, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.StatusCode, string(data))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.cardinalstreaming.com/readyz"))
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

C#

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.cardinalstreaming.com/readyz");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

Response 200

{
  "status": "ready"
}