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

Method	HTTP request	Description
get_system_info	GET /v1/system/info	Retrieve server build metadata
initialize_system	POST /v1/system/init	Initialize the system

get_system_info

SystemInfoResponse get_system_info()

Retrieve server build metadata

Returns the server's advertised semantic version, git metadata, build timestamp, and optional capability flags. The endpoint is intentionally unauthenticated so bootstrap tooling can call it before API keys exist.

Example

import goodmem_client
from goodmem_client.models.system_info_response import SystemInfoResponse
from goodmem_client.rest import ApiException
from pprint import pprint

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

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

    try:
        # Retrieve server build metadata
        api_response = api_instance.get_system_info()
        print("The response of SystemApi->get_system_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->get_system_info: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

SystemInfoResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Server build metadata	-
500	Internal server error	-

↑ Back to Python SDK

initialize_system

SystemInitResponse initialize_system(body=body)

Initialize the system

Initializes the system by creating a root user and API key. This endpoint should only be called once during first-time setup. If the system is already initialized, the endpoint will return a success response without creating new credentials.

Example

import goodmem_client
from goodmem_client.models.system_init_response import SystemInitResponse
from goodmem_client.rest import ApiException
from pprint import pprint

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

# Enter a context with an instance of the API client
with goodmem_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = goodmem_client.SystemApi(api_client)
    body = None # object | Empty request body - no parameters required (optional)

    try:
        # Initialize the system
        api_response = api_instance.initialize_system(body=body)
        print("The response of SystemApi->initialize_system:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemApi->initialize_system: %s\n" % e)