HealthResource: Service Status Check

check

check(*, options=None)

Performs a GET /api/health request and returns the server’s health status. This is the fastest way to verify connectivity and SDK configuration.

Returns

A dict with at least these fields:

status: a human-readable status string such as "ok"
version: the running Figranium server version

Example: verify connectivity

health_check.py

status = client.health.check()
print(status["status"])   # "ok"
print(status["version"])  # "0.14.4"

Example: no authentication needed

Because check() requires no authentication, you can call it before the user has signed in or provided an API key:

health_no_auth.py

client = Figranium(base_url="https://figranium.example")
status = client.health.check()
print(status["status"])

Example: handle transport failures

Wrap check() in a try/except to detect network or DNS issues. Transport failures surface as FigraniumError with code="NETWORK_ERROR":

health_transport.py

from figranium import Figranium, FigraniumError

client = Figranium(base_url="https://figranium.example")

try:
    status = client.health.check()
    print("Server is up:", status["status"])
except FigraniumError as error:
    if error.code == "NETWORK_ERROR":
        print("Cannot reach the Figranium server. Check the base_url and network.")
    raise

The check() method accepts the standard RequestOptions dict as its options keyword argument, so you can pass custom headers or a per-request timeout when needed.

Errors

Handle FigraniumError responses, including NETWORK_ERROR.

Request options

Pass custom headers and per-request timeout overrides.

JavaScript SDK

Python SDK

Swift SDK

HealthResource: Service Status Check

Client setup

Methods

Returns

Example: verify connectivity

Example: no authentication needed

Example: handle transport failures

Errors

Request options

​Client setup

​Methods

​Returns

​Example: verify connectivity

​Example: no authentication needed

​Example: handle transport failures

​Related resources

Errors

Request options

Client setup

Methods

Returns

Example: verify connectivity

Example: no authentication needed

Example: handle transport failures

Related resources