jellyfin.generated.api_10_11.ClientLogApi

All URIs are relative to http://localhost

Method HTTP request Description
log_file POST /ClientLog/Document Upload a document.

log_file

ClientLogDocumentResponseDto log_file(body=body)

Upload a document.

Example

  • Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.client_log_document_response_dto import ClientLogDocumentResponseDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint

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

# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"


# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jellyfin.generated.api_10_11.ClientLogApi(api_client)
    body = None # bytearray |  (optional)

    try:
        # Upload a document.
        api_response = api_instance.log_file(body=body)
        print("The response of ClientLogApi->log_file:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ClientLogApi->log_file: %s\n" % e)

Parameters

Name Type Description Notes
body bytearray [optional]

Return type

ClientLogDocumentResponseDto

Authorization

CustomAuthentication

HTTP request headers

  • Content-Type: text/plain
  • Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html

HTTP response details

Status code Description Response headers
200 Document saved. -
403 Event logging disabled. -
413 Upload size too large. -
503 The server is currently starting or is temporarily not available. * Retry-After - A hint for when to retry the operation in full seconds.
* Message - A short plain-text reason why the server is not available.
401 Unauthorized -

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