SystemConfigV1alpha1ConsoleApi.md

halo_client.SystemConfigV1alpha1ConsoleApi

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

Method	HTTP request	Description
get_system_config_by_group	GET /apis/console.api.halo.run/v1alpha1/systemconfigs/{group}
update_system_config_by_group	PUT /apis/console.api.halo.run/v1alpha1/systemconfigs/{group}

get_system_config_by_group

object get_system_config_by_group(group)

Get system config by group

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.SystemConfigV1alpha1ConsoleApi(api_client)
    group = 'group_example' # str | Group of the system config

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

Parameters

Name	Type	Description	Notes
group	str	Group of the system config

Return type

object

Authorization

basicAuth, bearerAuth

HTTP request headers

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

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]

update_system_config_by_group

update_system_config_by_group(group, body=body)

Update system config by group

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.SystemConfigV1alpha1ConsoleApi(api_client)
    group = 'group_example' # str | Group of the system config
    body = None # object |  (optional)

    try:
        api_instance.update_system_config_by_group(group, body=body)
    except Exception as e:
        print("Exception when calling SystemConfigV1alpha1ConsoleApi->update_system_config_by_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group	str	Group of the system config
body	object		[optional]

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204 NO_CONTENT	default response	-

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