StatusApi.md

openapi_client.StatusApi

All URIs are relative to https://api.mailbaby.net

Method	HTTP request	Description
ping_server	GET /ping	Checks if the server is running

ping_server

ping_server()

Checks if the server is running

Example

• Api Key Authentication (apiKeyAuth):

import time
import os
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mailbaby.net
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api.mailbaby.net"
)

# 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: apiKeyAuth
configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]

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

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

    try:
        # Checks if the server is running
        api_instance.ping_server()
    except Exception as e:
        print("Exception when calling StatusApi->ping_server: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

apiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Server is up and running	-
0	Something is wrong	-

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