plexcsharp/docs/sdks/general

General

(General)

Overview

General endpoints for basic PMS operation not specific to any media provider

Available Operations

• GetServerInfo - Get PMS info
• GetIdentity - Get PMS identity
• GetSourceConnectionInformation - Get Source Connection Information
• GetTransientToken - Get Transient Tokens

GetServerInfo

Information about this PMS setup and configuration

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    clientIdentifier: "abc123",
    product: "Plex for Roku",
    version: "2.4.1",
    platform: "Roku",
    platformVersion: "4.3 build 1057",
    device: "Roku 3",
    model: "4200X",
    deviceVendor: "Roku",
    deviceName: "Living Room TV",
    marketplace: "googlePlay",
    token: "<YOUR_API_KEY_HERE>"
);

GetServerInfoRequest req = new GetServerInfoRequest() {};

var res = await sdk.General.GetServerInfoAsync(req);

// handle response

Parameters

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

Response

GetServerInfoResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetIdentity

Get details about this PMS's identity

Example Usage

using LukeHagar.PlexAPI.SDK;

var sdk = new PlexAPI();

var res = await sdk.General.GetIdentityAsync();

// handle response

Response

GetIdentityResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetSourceConnectionInformation

If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token.

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    clientIdentifier: "abc123",
    product: "Plex for Roku",
    version: "2.4.1",
    platform: "Roku",
    platformVersion: "4.3 build 1057",
    device: "Roku 3",
    model: "4200X",
    deviceVendor: "Roku",
    deviceName: "Living Room TV",
    marketplace: "googlePlay",
    token: "<YOUR_API_KEY_HERE>"
);

GetSourceConnectionInformationRequest req = new GetSourceConnectionInformationRequest() {
    Source = "server://client-identifier",
    Refresh = BoolInt.True,
};

var res = await sdk.General.GetSourceConnectionInformationAsync(req);

// handle response

Parameters

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

Response

GetSourceConnectionInformationResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetTransientToken

This endpoint provides the caller with a temporary token with the same access level as the caller's token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted. Note: This endpoint responds to all HTTP verbs but POST in preferred

Example Usage

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

var sdk = new PlexAPI(
    accepts: LukeHagar.PlexAPI.SDK.Models.Components.Accepts.ApplicationXml,
    clientIdentifier: "abc123",
    product: "Plex for Roku",
    version: "2.4.1",
    platform: "Roku",
    platformVersion: "4.3 build 1057",
    device: "Roku 3",
    model: "4200X",
    deviceVendor: "Roku",
    deviceName: "Living Room TV",
    marketplace: "googlePlay",
    token: "<YOUR_API_KEY_HERE>"
);

GetTransientTokenRequest req = new GetTransientTokenRequest() {
    Type = QueryParamType.Delegation,
    Scope = Scope.All,
};

var res = await sdk.General.GetTransientTokenAsync(req);

// handle response

Parameters

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

Response

GetTransientTokenResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*