jellyfin-api/org.jellyfin.sdk.api.operations/SystemApi

SystemApi

class SystemApi(api: ApiClient) : Api

Constructors

constructor(api: ApiClient)

Functions

getConfiguration

suspend fun getConfiguration(): Response<ServerConfiguration>

Gets application configuration.

getDefaultMetadataOptions

suspend fun getDefaultMetadataOptions(): Response<MetadataOptions>

Gets a default MetadataOptions object.

getEndpointInfo

suspend fun getEndpointInfo(): Response<EndPointInfo>

Gets information about the request endpoint.

suspend fun getLogEntries(request: GetLogEntriesRequest = GetLogEntriesRequest()): Response<ActivityLogEntryQueryResult>

suspend fun getLogEntries(startIndex: Int? = null, limit: Int? = null, minDate: DateTime? = null, maxDate: DateTime? = null, hasUserId: Boolean? = null, name: String? = null, overview: String? = null, shortOverview: String? = null, type: String? = null, itemId: UUID? = null, username: String? = null, severity: LogLevel? = null, sortBy: Collection<ActivityLogSortBy>? = emptyList(), sortOrder: Collection<SortOrder>? = emptyList()): Response<ActivityLogEntryQueryResult>

Gets activity log entries.

suspend fun getLogFile(name: String): Response<String>

Gets a log file.

getNamedConfiguration

suspend fun getNamedConfiguration(key: String): Response<ByteArray>

Gets a named configuration.

getNamedConfigurationUrl

fun getNamedConfigurationUrl(key: String): String

Gets a named configuration.

suspend fun getPingSystem(): Response<String>

Pings the system.

getPublicSystemInfo

suspend fun getPublicSystemInfo(): Response<PublicSystemInfo>

Gets public information about the server.

suspend fun getServerLogs(): Response<List<LogFile>>

Gets a list of available server log files.

suspend fun getSystemInfo(): Response<SystemInfo>

Gets information about the server.

getSystemStorage

suspend fun getSystemStorage(): Response<SystemStorageDto>

Gets information about the server.

suspend fun getUtcTime(): Response<UtcTimeResponse>

Gets the current UTC time.

suspend fun logFile(data: String): Response<ClientLogDocumentResponseDto>

Upload a document.

suspend fun postPingSystem(): Response<String>

Pings the system.

restartApplication

suspend fun restartApplication(): Response<Unit>

Restarts the application.

shutdownApplication

suspend fun shutdownApplication(): Response<Unit>

Shuts down the application.

updateBrandingConfiguration

suspend fun updateBrandingConfiguration(data: BrandingOptionsDto): Response<Unit>

Updates branding configuration.

updateConfiguration

suspend fun updateConfiguration(data: ServerConfiguration): Response<Unit>

Updates application configuration.

updateNamedConfiguration

suspend fun updateNamedConfiguration(key: String, data: JsonElement): Response<Unit>

Updates named configuration.