swagger_client.HealthCheckApi

July 10, 2024 ยท View on GitHub

All URIs are relative to https://data.elexon.co.uk/bmrs/api/v1

MethodHTTP requestDescription
health_getGET /healthHealth check

health_get

health_get()

Health check

This endpoint provides a success status code (200) if the service is alive

Example

from __future__ import print_function
import time
import elexonpy
from elexonpy.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = elexonpy.HealthCheckApi()

try:
    # Health check
    api_instance.health_get()
except ApiException as e:
    print("Exception when calling HealthCheckApi->health_get: %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

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