plexgo/docs/sdks/server/README.md

Server

(Server)

Overview

Operations against the Plex Media Server System.

Available Operations

• GetServerCapabilities - Get Server Capabilities
• GetServerPreferences - Get Server Preferences
• GetAvailableClients - Get Available Clients
• GetDevices - Get Devices
• GetServerIdentity - Get Server Identity
• GetMyPlexAccount - Get MyPlex Account
• GetResizedPhoto - Get a Resized Photo
• GetMediaProviders - Get Media Providers
• GetServerList - Get Server List

GetServerCapabilities

Get Server Capabilities

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetServerCapabilities(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetServerCapabilitiesResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetServerCapabilitiesResponseBody	400	application/json
sdkerrors.GetServerCapabilitiesServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetServerPreferences

Get Server Preferences

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetServerPreferences(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetServerPreferencesResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetServerPreferencesResponseBody	400	application/json
sdkerrors.GetServerPreferencesServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetAvailableClients

Get Available Clients

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetAvailableClients(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetAvailableClientsResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetAvailableClientsResponseBody	400	application/json
sdkerrors.GetAvailableClientsServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetDevices

Get Devices

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetDevices(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetDevicesResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetDevicesResponseBody	400	application/json
sdkerrors.GetDevicesServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetServerIdentity

This request is useful to determine if the server is online or offline

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetServerIdentity(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetServerIdentityResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetServerIdentityResponseBody	408	application/json
sdkerrors.SDKError	4xx-5xx	/

GetMyPlexAccount

Returns MyPlex Account Information

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetMyPlexAccount(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetMyPlexAccountResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetMyPlexAccountResponseBody	400	application/json
sdkerrors.GetMyPlexAccountServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetResizedPhoto

Plex's Photo transcoder is used throughout the service to serve images at specified sizes.

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetResizedPhoto(ctx, operations.GetResizedPhotoRequest{
        Width: 110,
        Height: 165,
        Opacity: 100,
        Blur: 20,
        MinSize: operations.MinSizeOne,
        Upscale: operations.UpscaleOne,
        URL: "/library/metadata/49564/thumb/1654258204",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.GetResizedPhotoRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetResizedPhotoResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetResizedPhotoResponseBody	400	application/json
sdkerrors.GetResizedPhotoServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetMediaProviders

Retrieves media providers and their features from the Plex server.

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetMediaProviders(ctx, "CV5xoxjTpFKUzBTShsaf")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
xPlexToken	string	✔️	Plex Authentication Token	CV5xoxjTpFKUzBTShsaf
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetMediaProvidersResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetMediaProvidersResponseBody	400	application/json
sdkerrors.GetMediaProvidersServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/

GetServerList

Get Server List

Example Usage

package main

import(
	"github.com/LukeHagar/plexgo"
	"context"
	"log"
)

func main() {
    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
        plexgo.WithXPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40"),
    )

    ctx := context.Background()
    res, err := s.Server.GetServerList(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetServerListResponse, error

Errors

Error Object	Status Code	Content Type
sdkerrors.GetServerListResponseBody	400	application/json
sdkerrors.GetServerListServerResponseBody	401	application/json
sdkerrors.SDKError	4xx-5xx	/