Settings - lokenx/plex-requests GitHub Wiki

GET: /settings

Summary

Returns an object container the application settings. This requires authenticating with an admin user JWT.

Parameters

None.

Returned JSON

{
    statusCode: 200,
    data: {
        "authentication": {
            "enabled": false,
            "passwordrequired": false,
            "plextoken": "abcd123",
            "blockedusers": []
        },
        "searching": {
            "movies": true,
            "tv": true
        },
        "requests": {
            "movielimit": 0,
            "tvlimit": 0
        },
        "couchpotato": {
            "url": "192.168.0.1",
            "port": 5050,
            "ssl": false,
            "api": "abcd123",
            "directory": "",
            "enabled": false
        },
        "sickrage": {
            "url": "192.168.0.1",
            "port": 8081,
            "ssl": false,
            "api": "abcd123",
            "directory": "",
            "enabled": false
        },
        "sonarr": {
            "url": "192.168.0.1",
            "port": 8989,
            "ssl": false,
            "api": "abcd123",
            "directory": "",
            "qualityprofileid": 1,
            "rootfolderpath": "/path/to/root/tv/folder",
            "seasonfolders": true,
            "enabled": false
        },
        "pushbullet": {
            "token": "abcd123",
            "enabled": false
        },
        "pushover": {
            "token": "abcd123",
            "user": "user",
            "enabled": false
        }
    },
    meta: {}
}

---

GET: /settings/app

Summary

Returns an object container specific application settings required by the user application.

Parameters

None.

Returned JSON

{
    statusCode: 200,
    data: {
        "movies": true,
        "tv": true
    },
    meta: {}
}

---

PUT: /settings

Summary

Updates application settings. This requires authenticating with an admin user JWT.

Parameters

Settings object should be provided in the body, JSON encoded. You need to provide a full sub section of the settings.

{
    authentication: {
        enabled: true,
        passwordrequired: false,
        plextoken: "abcd123",
        blockedusers: []
    }
}

Returned JSON

{
    "statusCode": 200,
    data: {
        "authentication": {
            "enabled": true,
            "passwordrequired": false,
            "plextoken": "abcd123",
            "blockedusers": []
        },
        "searching": {
            "movies": true,
            "tv": true
        },
        "requests": {
            "movielimit": 0,
            "tvlimit": 0
        },
        "couchpotato": {
            "url": "192.168.0.1",
            "port": 5050,
            "ssl": false,
            "api": "abcd123",
            "directory": "",
            "enabled": false
        },
        "sickrage": {
            "url": "192.168.0.1",
            "port": 8081,
            "ssl": false,
            "api": "abcd123",
            "directory": "",
            "enabled": false
        },
        "sonarr": {
            "url": "192.168.0.1",
            "port": 8989,
            "ssl": false,
            "api": "abcd123",
            "directory": "",
            "qualityprofileid": 1,
            "rootfolderpath": "/path/to/root/tv/folder",
            "seasonfolders": true,
            "enabled": false
        },
        "pushbullet": {
            "token": "abcd123",
            "enabled": false
        },
        "pushover": {
            "token": "abcd123",
            "user": "user",
            "enabled": false
        }
    },
    "meta": {}
}