# Health

## Get comprehensive health check status

> Returns detailed health information including database connectivity, version info, and system status. This endpoint is used by monitoring systems and load balancers. Returns 503 if critical systems (database, GitHub, Salesforce) are unhealthy.

```json
{"openapi":"3.0.0","info":{"title":"sfp server","version":"51.9.0"},"paths":{"/sfp/api":{"get":{"operationId":"AppController_getHealth","summary":"Get comprehensive health check status","description":"Returns detailed health information including database connectivity, version info, and system status. This endpoint is used by monitoring systems and load balancers. Returns 503 if critical systems (database, GitHub, Salesforce) are unhealthy.","parameters":[],"responses":{"200":{"description":"All critical systems are healthy"},"503":{"description":"One or more critical systems are unhealthy"}},"tags":["Health"]}}}}
```

## Health check endpoint accessible at /health

> Simple health check endpoint that bypasses the global prefix. Returns the same comprehensive health status as the root endpoint. Commonly used by Kubernetes and other orchestration systems. Returns 503 if critical systems (database, GitHub, Salesforce) are unhealthy.

```json
{"openapi":"3.0.0","info":{"title":"sfp server","version":"51.9.0"},"paths":{"/health":{"get":{"operationId":"AppController_getHealthDirect","summary":"Health check endpoint accessible at /health","description":"Simple health check endpoint that bypasses the global prefix. Returns the same comprehensive health status as the root endpoint. Commonly used by Kubernetes and other orchestration systems. Returns 503 if critical systems (database, GitHub, Salesforce) are unhealthy.","parameters":[],"responses":{"200":{"description":"All critical systems are healthy"},"503":{"description":"One or more critical systems are unhealthy"}},"tags":["Health"]}}}}
```

## Get an echo test

> Simple ping endpoint that returns a static "pong" response. Useful for basic connectivity testing and latency measurements.

```json
{"openapi":"3.0.0","info":{"title":"sfp server","version":"51.9.0"},"paths":{"/sfp/api/ping":{"get":{"operationId":"AppController_getHealthPing","summary":"Get an echo test","description":"Simple ping endpoint that returns a static \"pong\" response. Useful for basic connectivity testing and latency measurements.","parameters":[],"responses":{"200":{"description":""}},"tags":["Health"]}}}}
```

## Get web app runtime configuration

> Returns public configuration values for the web app including Supabase credentials, tenant info, and auth provider settings. These values are safe to expose publicly - security is enforced via Supabase RLS, not key secrecy.

```json
{"openapi":"3.0.0","info":{"title":"sfp server","version":"51.9.0"},"paths":{"/sfp/api/config":{"get":{"operationId":"AppController_getWebAppConfig","summary":"Get web app runtime configuration","description":"Returns public configuration values for the web app including Supabase credentials, tenant info, and auth provider settings. These values are safe to expose publicly - security is enforced via Supabase RLS, not key secrecy.","parameters":[],"responses":{"200":{"description":"Web app configuration","content":{"application/json":{"schema":{"type":"object","properties":{"supabaseUrl":{"type":"string"},"supabaseAnonKey":{"type":"string"},"serverUrl":{"type":"string"},"tenantLabel":{"type":"string"},"authProvider":{"type":"string"},"webAppVersion":{"type":"string"},"deploymentMode":{"type":"string","enum":["cloud","self-hosted"]},"sso":{"type":"object","properties":{"domain":{"type":"string"},"providerId":{"type":"string"}}}}}}}}},"tags":["Health"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flxbl.io/flxbl/sfp-server/api-reference/health.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.