settings

Update main settings

Changed on

Updates main settings with the provided values.

post/settings/main

Request

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

Request body

apiKeystring
appLanguagestring
applicationTitlestring
applicationUrlstring
hideAvailableboolean
hideRequestedboolean
partialRequestsEnabledboolean
localLoginboolean
mediaServerTypenumber
newPlexLoginboolean
defaultPermissionsnumber
enableSpecialEpisodesboolean
versionCheckboolean

Example request

{
  "appLanguage": "en",
  "applicationTitle": "Seerr",
  "applicationUrl": "https://os.example.com",
  "localLogin": true,
  "mediaServerType": 1,
  "newPlexLogin": true,
  "defaultPermissions": 32
}

Response

Values were sucessfully updated

apiKeystring
appLanguagestring
applicationTitlestring
applicationUrlstring
hideAvailableboolean
hideRequestedboolean
partialRequestsEnabledboolean
localLoginboolean
mediaServerTypenumber
newPlexLoginboolean
defaultPermissionsnumber
enableSpecialEpisodesboolean
versionCheckboolean

Example response

{
  "appLanguage": "en",
  "applicationTitle": "Seerr",
  "applicationUrl": "https://os.example.com",
  "localLogin": true,
  "mediaServerType": 1,
  "newPlexLogin": true,
  "defaultPermissions": 32
}

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status