Sourced
llms.txt
View Markdown

System ยท version 0.1.0

Service health probe

GET/api/health

Unauthenticated readiness probe. Reports control-plane mode and which optional integrations (storage, queue, hosted worker) are configured.

Request

cURL
curl -X GET 'https://sourced.sh/api/health' \
  -H 'Authorization: Bearer $SOURCED_API_KEY'
TypeScript
const response = await fetch("https://sourced.sh/api/health", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.SOURCED_API_KEY}`,
  },
});
const data = await response.json();
Python
import os
import requests

response = requests.request(
    "GET",
    "https://sourced.sh/api/health",
    headers={"Authorization": f"Bearer {os.environ['SOURCED_API_KEY']}"},
)

data = response.json()

Responses

200

Service is reachable.

application/json

Schema
HealthStatus:
  type: object
  required: ok, service, mode, generatedAt
  properties:
    ok (required): boolean
    service (required): string
    mode (required): string enum neon-control-plane | local-json-control-plane | not-configured-control-plane
    accounts: boolean
    projects: boolean
    persistedRuns: boolean
    hostedReports: boolean
    storage: boolean
    queue: boolean
    pipeline: object
    generatedAt (required): string
Was this helpful?