Sign in
settings

Update Plex settings

Updates Plex settings with the provided values.

post/settings/plex

Request

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

Request body

namestring required
machineIdstring required
ipstring required
portnumber required
useSslboolean nullable
webAppUrlstring nullable

Example request

{
  "name": "Main Server",
  "machineId": "1234123412341234",
  "ip": "127.0.0.1",
  "port": 32400,
  "libraries": [
    {
      "name": "Movies"
    }
  ],
  "webAppUrl": "https://app.plex.tv/desktop"
}

Response

Values were successfully updated

namestring required
machineIdstring required
ipstring required
portnumber required
useSslboolean nullable
webAppUrlstring nullable

Example response

{
  "name": "Main Server",
  "machineId": "1234123412341234",
  "ip": "127.0.0.1",
  "port": 32400,
  "libraries": [
    {
      "name": "Movies"
    }
  ],
  "webAppUrl": "https://app.plex.tv/desktop"
}

Changes

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