Tell grabbers to discover devices

Tell grabbers to discover devices

POST /media/grabbers/devices/discover

PlexGO

Go

package main

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

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Devices.DiscoverDevices(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.MediaContainerWithDevice != nil {
        // handle response
    }
}

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.operations.DiscoverDevicesResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        PlexAPI sdk = PlexAPI.builder()
                .token(System.getenv().getOrDefault("TOKEN", ""))
            .build();

        DiscoverDevicesResponse res = sdk.devices().discoverDevices()
                .call();

        if (res.mediaContainerWithDevice().isPresent()) {
            // handle response
        }
    }
}

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  token: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await plexAPI.devices.discoverDevices();

  console.log(result);
}

run();

curl --request POST \
  --url https://{IP-description}.{identifier}.plex.direct:{port}/media/grabbers/devices/discover \
  --header 'X-Plex-Token: <api-key>'

import requests

url = "https://{IP-description}.{identifier}.plex.direct:{port}/media/grabbers/devices/discover"

headers = {"X-Plex-Token": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-Plex-Token': '<api-key>'}};

fetch('https://{IP-description}.{identifier}.plex.direct:{port}/media/grabbers/devices/discover', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "https://{IP-description}.{identifier}.plex.direct:{port}/media/grabbers/devices/discover",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Plex-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://{IP-description}.{identifier}.plex.direct:{port}/media/grabbers/devices/discover")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Plex-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "MediaContainer": {
    "identifier": "<string>",
    "offset": 123,
    "size": 123,
    "totalSize": 123,
    "Device": [
      {
        "ChannelMapping": [
          {
            "channelKey": "<string>",
            "deviceIdentifier": "<string>",
            "enabled": "<string>",
            "lineupIdentifier": "<string>"
          }
        ],
        "key": "<string>",
        "lastSeenAt": 123,
        "make": "<string>",
        "model": "<string>",
        "modelNumber": "<string>",
        "protocol": "<string>",
        "sources": "<string>",
        "state": "<string>",
        "status": "<string>",
        "tuners": "<string>",
        "uri": "<string>",
        "uuid": "<string>"
      }
    ]
  }
}

Authorizations

X-Plex-Token · string · header · required

The token which identifies the user accessing the PMS. This can be either:

• A traditional access token obtained from plex.tv
• A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

• Short-lived tokens (7 days expiration)
• Public-key cryptography (ED25519)
• Better clock synchronization
• Individual device revocation capability

Response

200 - application/json

OK

MediaContainer · object

MediaContainer is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable. Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination) The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the parentTitle attribute may appear on the MediaContainer rather than being repeated on each track.

Show child attributes