StatusApi.md

py_logto.StatusApi

All URIs are relative to http://localhost

Method	HTTP request	Description
get_status	GET /api/status	Health check

get_status

get_status()

Health check

The traditional health check API. No authentication needed. > Note > Even if 204 is returned, it does not guarantee all the APIs are working properly since they may depend on additional resources or external services.

Example

import py_logto
from py_logto.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 = py_logto.Configuration(
    host = "http://localhost"
)


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

    try:
        # Health check
        api_instance.get_status()
    except Exception as e:
        print("Exception when calling StatusApi->get_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	The Logto core service is healthy.	-

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