settings

Get main settings

Changed on

Retrieves all main settings in a JSON object.

get/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

Response

OK

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