Skip to content

HealthApi.md

Latest commit

 

History

History
73 lines (46 loc) · 1.8 KB

HealthApi.md

File metadata and controls

73 lines (46 loc) · 1.8 KB

stratum.HealthApi

All URIs are relative to http://localhost:3000

Method HTTP request Description
get_health GET /api/v1/health Health check

get_health

HealthResponse get_health()

Health check

Returns the health status of the control plane, including database and Redis connectivity.

Example

import stratum
from stratum.models.health_response import HealthResponse
from stratum.rest import ApiException
from pprint import pprint

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


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

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

Parameters

This endpoint does not need any parameter.

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Health status -

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