Log

(Log)

Overview

Submit logs to the Log Handler for Plex Media Server

Available Operations

LogLine - Logging a single line message.
LogMultiLine - Logging a multi-line message
EnablePaperTrail - Enabling Papertrail

LogLine

This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);

var res = await sdk.Log.LogLineAsync(
    level: LukeHagar.PlexAPI.SDK.Models.Requests.Level.Three,
    message: "Test log message",
    source: "Postman"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Level`	Level	✔️	An integer log level to write to the PMS log with. 0: Error 1: Warning 2: Info 3: Debug 4: Verbose
`Message`	string	✔️	The text of the message to write to the log.	Test log message
`Source`	string	✔️	a string indicating the source of the message.	Postman

Response

LogLineResponse

Errors

Error Object	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.LogLineResponseBody	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.LogLineLogResponseBody	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4xx-5xx	/

LogMultiLine

This endpoint allows for the batch addition of log entries to the main Plex Media Server log.
It accepts a text/plain request body, where each line represents a distinct log entry.
Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'.

Log entries are separated by a newline character (\n).
Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters.
This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests.

The 'level' parameter specifies the log entry's severity or importance, with the following integer values:

0: Error - Critical issues that require immediate attention.
1: Warning - Important events that are not critical but may indicate potential issues.
2: Info - General informational messages about system operation.
3: Debug - Detailed information useful for debugging purposes.
4: Verbose - Highly detailed diagnostic information for in-depth analysis.

The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module).

Example of a single log entry format: level=4&message=Sample%20log%20entry&source=applicationName

Ensure each parameter is properly URL-encoded to avoid interpretation issues.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);

string req = "level=4&message=Test%20message%201&source=postman
level=3&message=Test%20message%202&source=postman
level=1&message=Test%20message%203&source=postman";

var res = await sdk.Log.LogMultiLineAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	string	✔️	The request object to use for the request.

Response

LogMultiLineResponse

Errors

Error Object	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.LogMultiLineResponseBody	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.LogMultiLineLogResponseBody	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4xx-5xx	/

EnablePaperTrail

This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time.

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    xPlexClientIdentifier: "gcgzw5rz2xovp84b4vha3a40"
);

var res = await sdk.Log.EnablePaperTrailAsync();

// handle response

Response

EnablePaperTrailResponse

Errors

Error Object	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.EnablePaperTrailResponseBody	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.EnablePaperTrailLogResponseBody	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4xx-5xx	/