Skip to content

HealthApi.md

Latest commit

 

History

History
83 lines (55 loc) · 2.41 KB

HealthApi.md

File metadata and controls

83 lines (55 loc) · 2.41 KB

hyperstack.HealthApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
healthz_endpoint GET /object-storage/healthz Healthcheck

healthz_endpoint

ObjectStorageHealthResponse healthz_endpoint()

Healthcheck

Example

  • Api Key Authentication (apiKey):
import hyperstack
from hyperstack.models.object_storage_health_response import ObjectStorageHealthResponse
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

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

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

Parameters

This endpoint does not need any parameter.

Return type

ObjectStorageHealthResponse

Authorization

apiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
422 Validation Error -

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