Skip to content

Latest commit

 

History

History
244 lines (186 loc) · 7.76 KB

AdminApi.md

File metadata and controls

244 lines (186 loc) · 7.76 KB

nexus_sdk.AdminApi

All URIs are relative to https://scientia.atinary.com/nexus/api/latest

Method HTTP request Description
health_check GET /Healthcheck Health check
service_information GET /ServiceInfo Service information.

health_check

HealthCheckReport health_check()

Health check

The Healthcheck endpoint provides detailed information about the health of a web service.

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import nexus_sdk
from nexus_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://scientia.atinary.com/nexus/api/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = nexus_sdk.Configuration(
    host = "https://scientia.atinary.com/nexus/api/latest"
)

# 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: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): tokens
configuration = nexus_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with nexus_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nexus_sdk.AdminApi(api_client)
    
    try:
        # Health check
        api_response = api_instance.health_check()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->health_check: %s\n" % e)
  • Bearer (JWT) Authentication (tokens):
from __future__ import print_function
import time
import nexus_sdk
from nexus_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://scientia.atinary.com/nexus/api/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = nexus_sdk.Configuration(
    host = "https://scientia.atinary.com/nexus/api/latest"
)

# 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: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): tokens
configuration = nexus_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with nexus_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nexus_sdk.AdminApi(api_client)
    
    try:
        # Health check
        api_response = api_instance.health_check()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->health_check: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HealthCheckReport

Authorization

api_key, tokens

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
0 Unhealthy response -

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

service_information

ServiceInfoResponse service_information()

Service information.

Get service configuration information.

Example

  • Api Key Authentication (api_key):
from __future__ import print_function
import time
import nexus_sdk
from nexus_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://scientia.atinary.com/nexus/api/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = nexus_sdk.Configuration(
    host = "https://scientia.atinary.com/nexus/api/latest"
)

# 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: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): tokens
configuration = nexus_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with nexus_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nexus_sdk.AdminApi(api_client)
    
    try:
        # Service information.
        api_response = api_instance.service_information()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->service_information: %s\n" % e)
  • Bearer (JWT) Authentication (tokens):
from __future__ import print_function
import time
import nexus_sdk
from nexus_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://scientia.atinary.com/nexus/api/latest
# See configuration.py for a list of all supported configuration parameters.
configuration = nexus_sdk.Configuration(
    host = "https://scientia.atinary.com/nexus/api/latest"
)

# 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: api_key
configuration.api_key['api_key'] = 'YOUR_API_KEY'

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

# Configure Bearer authorization (JWT): tokens
configuration = nexus_sdk.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with nexus_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nexus_sdk.AdminApi(api_client)
    
    try:
        # Service information.
        api_response = api_instance.service_information()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdminApi->service_information: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ServiceInfoResponse

Authorization

api_key, tokens

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful response -
0 error response -

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