Authentication#

class qbittorrentapi.auth.AuthAPIMixIn(host='', port=None, username=None, password=None, **kwargs)#

Bases: Request

Implementation of all Authorization API methods.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> _ = client.is_logged_in
>>> client.auth_log_in(username='admin', password='adminadmin')
>>> client.auth_log_out()

auth_log_in(username=None, password=None, **kwargs)#

Raises:

LoginFailed – if credentials failed to log in
Forbidden403Error – if user is banned…or not logged in

Parameters:

username – username for qBittorrent client
password – password for qBittorrent client

Returns:

None

auth_log_out(**kwargs)#: End session with qBittorrent.

property is_logged_in#

Returns True if low-overhead API call succeeds; False otherwise.

There isn’t a reliable way to know if an existing session is still valid without attempting to use it. qBittorrent invalidates cookies when they expire.

Returns:: True/False if current auth cookie is accepted by qBittorrent.

class qbittorrentapi.auth.Authorization(*args, **kwargs)#

Allows interaction with the Authorization API endpoints.

Usage:

>>> from qbittorrentapi import Client
>>> client = Client(host='localhost:8080', username='admin', password='adminadmin')
>>> is_logged_in = client.auth.is_logged_in
>>> client.auth.log_in(username='admin', password='adminadmin')
>>> client.auth.log_out()

property is_logged_in#: Implements is_logged_in()

log_in(username=None, password=None, **kwargs)#: Implements auth_log_in()

log_out(**kwargs)#: Implements auth_log_out()