client.health

Check API health status

Signature

class Client {
  health(): Promise<{ status: string }>
}

Parameters

No parameters.

Examples

import { Client } from '@blueforge/client'
const bf = new Client({ apiKey: process.env.BF_API_KEY!, url: 'https://your-project.blueforge.dev' })

const { status } = await bf.health()
console.log(status) // 'ok' | 'degraded'

Throws

ApiError

NetworkError

Pitfalls

• No auth required — the health endpoint is unauthenticated

See also

{auto-injected}

Tested against

{auto-injected}