rmi-backend/sdks/python/docs/HealthApi.md

rugmunch.HealthApi

All URIs are relative to http://localhost

Method	HTTP request	Description
health_health_get	GET /health	Health
live_live_get	GET /live	Live
ready_ready_get	GET /ready	Ready

health_health_get

object health_health_get()

Health

Deep health — runs every registered domain health check.

Each domain registers its own check via core.health.register_health_check(). Returns 200 if all domains healthy, 503 if any critical domain down.

Example

import rugmunch
from rugmunch.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rugmunch.HealthApi(api_client)

    try:
        # Health
        api_response = api_instance.health_health_get()
        print("The response of HealthApi->health_health_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->health_health_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

live_live_get

Dict[str, object] live_live_get()

Live

Liveness probe. Process up. Always 200 unless the process is dead.

Example

import rugmunch
from rugmunch.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rugmunch.HealthApi(api_client)

    try:
        # Live
        api_response = api_instance.live_live_get()
        print("The response of HealthApi->live_live_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->live_live_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

Dict[str, object]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ready_ready_get

object ready_ready_get()

Ready

Readiness probe. 200 if critical deps reachable, 503 otherwise.

Example

import rugmunch
from rugmunch.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = rugmunch.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with rugmunch.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rugmunch.HealthApi(api_client)

    try:
        # Ready
        api_response = api_instance.ready_ready_get()
        print("The response of HealthApi->ready_ready_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->ready_ready_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]