Disconnect
airvpn.api.disconnect
disconnect(session: AirSession, server_name: str = None, device: str = None) -> int
Requests a disconnection. If none of the filter parameters is specified, disconnect all sessions of the user.
Access type
User-specific, API KEY required.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
session
|
AirSession
|
The active AirSession used to make the API request. |
required |
server_name
|
str
|
Name of the server to disconnect from. |
None
|
device
|
str
|
ID/name of the device to disconnect. |
None
|
Returns:
| Type | Description |
|---|---|
int
|
The number of sessions that were disconnected. |
Raises:
| Type | Description |
|---|---|
APIError
|
If it fails to disconnect. |
RateLimited
|
If too many requests go through. |