@datalayer/core
Version:
[](https://datalayer.io)
17 lines (16 loc) • 546 B
TypeScript
import type { HealthzPingResponse } from '../../models/Common';
/**
* Health check ping endpoint
*
* @param baseUrl - Base URL for the API (defaults to production IAM URL)
* @returns Health check response with user count
* @throws {Error} If the health check fails
*
* @remarks
* This endpoint provides a basic health check for the IAM service.
* It returns the current user count in the system.
*
* Expected status codes:
* - 200: Service is healthy
*/
export declare const ping: (baseUrl?: string) => Promise<HealthzPingResponse>;