Sign in
settings

Gets the user's available Plex servers

Returns a list of available Plex servers and their connectivity state

get/settings/plex/devices/servers

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/settings/plex/devices/servers
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Response

OK

namestring required
productstring required
productVersionstring required
platformstring required
platformVersionstring
devicestring required
clientIdentifierstring required
createdAtstring required
lastSeenAtstring required
providesstring[] required
ownedboolean required
ownerIDstring
homeboolean
sourceTitlestring
accessTokenstring
publicAddressstring
httpsRequiredboolean
syncedboolean
relayboolean
dnsRebindingProtectionboolean
natLoopbackSupportedboolean
publicAddressMatchesboolean
presenceboolean

Example response

[
  {
    "name": "My Plex Server",
    "product": "Plex Media Server",
    "productVersion": "1.21",
    "platform": "Linux",
    "platformVersion": "default/linux/amd64/17.1/systemd",
    "device": "PC",
    "clientIdentifier": "85a943ce-a0cc-4d2a-a4ec-f74f06e40feb",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "lastSeenAt": "2021-01-01T00:00:00.000Z",
    "provides": [
      "server"
    ],
    "owned": true,
    "ownerID": "12345",
    "home": true,
    "sourceTitle": "xyzabc",
    "accessToken": "supersecretaccesstoken",
    "publicAddress": "127.0.0.1",
    "httpsRequired": true,
    "synced": true,
    "relay": true,
    "presence": true,
    "connection": [
      {
        "protocol": "https",
        "address": "127.0.0.1",
        "port": 32400,
        "uri": "https://127-0-0-1.2ab6ce1a093d465e910def96cf4e4799.plex.direct:32400",
        "local": true,
        "status": 200,
        "message": "OK"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 21 revisions of this API.