Skip to content

SystemV1alpha1PublicApi.md

Latest commit

 

History

History
246 lines (169 loc) · 6.99 KB

SystemV1alpha1PublicApi.md

File metadata and controls

246 lines (169 loc) · 6.99 KB

halo_client.SystemV1alpha1PublicApi

All URIs are relative to http://localhost:8091

Method HTTP request Description
jump_to_setup_page GET /system/setup
query_stats GET /apis/api.halo.run/v1alpha1/stats/-
setup_system POST /system/setup

jump_to_setup_page

str jump_to_setup_page()

Jump to setup page

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html

HTTP response details

Status code Description Response headers
0 default response -

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

query_stats

SiteStatsVo query_stats()

Gets site stats

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.site_stats_vo import SiteStatsVo
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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

Parameters

This endpoint does not need any parameter.

Return type

SiteStatsVo

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
0 default response -

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

setup_system

setup_system(setup_request)

Setup system

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.setup_request import SetupRequest
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.SystemV1alpha1PublicApi(api_client)
    setup_request = halo_client.SetupRequest() # SetupRequest | 

    try:
        api_instance.setup_system(setup_request)
    except Exception as e:
        print("Exception when calling SystemV1alpha1PublicApi->setup_system: %s\n" % e)

Parameters

Name Type Description Notes
setup_request SetupRequest

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -

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