libica.openapi.libconsole.HealthApi¶

All URIs are relative to https://aps2.platform.illumina.com

Method	HTTP request	Description
service_health	GET /v1/health	Returns the health status for all services.

service_health¶

SystemHealthResponse service_health()

Returns the health status for all services.

Example¶

Basic Authentication (Basic):

from __future__ import print_function
import time
import libica.openapi.libconsole
from libica.openapi.libconsole.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libconsole.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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 HTTP basic authorization: Basic
configuration = libica.openapi.libconsole.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: Bearer
configuration = libica.openapi.libconsole.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

    try:
        # Returns the health status for all services.
        api_response = api_instance.service_health()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HealthApi->service_health: %s\n" % e)

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libconsole
from libica.openapi.libconsole.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libconsole.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# 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 HTTP basic authorization: Basic
configuration = libica.openapi.libconsole.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: Bearer
configuration = libica.openapi.libconsole.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

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

    try:
        # Returns the health status for all services.
        api_response = api_instance.service_health()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HealthApi->service_health: %s\n" % e)

Parameters¶

This endpoint does not need any parameter.

Return type¶

SystemHealthResponse

Authorization¶

Basic, Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Health check succeeded	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

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