Password Management APIs

Bingo VPN provides comprehensive APIs for managing VPN passwords, including the ability to create temporary passwords for sharing access with team members. All passwords can be configured with an expiration time for enhanced security.

List Node Passwords

GET /api/v2/nodes/{node_id}/passwords/

Retrieve all passwords associated with a specific node.

Response Example:

{
    "success": true,
    "data": {
        "count": 3,
        "next": null,
        "previous": null,
        "results": [
            {
                "id": 37,
                "name": "normal",
                "node": 29,
                "password": "W3C34",
                "is_active": true,
                "bandwidth_limit": 10,
                "upload_transfer": 36035079,
                "download_transfer": 602186853,
                "transfer_limit": 2,
                "share_code": "TbTT67wHSweef",
                "transfer_is_monthly": false,
                "updated_at": "2025-02-17 13:48:35",
                "created_at": "2025-02-17 06:08:35"
            }
        ]
    },
    "error": null
}

Field Descriptions:

Field	Type	Description
id	Integer	Unique identifier for the password
name	String	Name to distinguish different passwords (e.g., normal user, VIP user)
node	Integer	ID of the server this password belongs to
password	String	Password used for connection
is_active	Boolean	Whether the password is enabled. When disabled, the password cannot be used
bandwidth_limit	Integer	Bandwidth limit in MB/s. Available values: 1, 5, 10, 20, 50
upload_transfer	Integer	Total upload traffic in bytes
download_transfer	Integer	Total download traffic in bytes
transfer_limit	Integer	Traffic limit in GB. 0 means no limit
share_code	String	Unique code for sharing the password. Used in share links
transfer_is_monthly	Boolean	Whether the traffic limit resets monthly
updated_at	String	Last update time
created_at	String	Creation time

Create Password

POST /api/v2/nodes/{node_id}/passwords/

Create a new password for a specific node. You can create multiple passwords for different team members, each with its own expiration time.

Request Body:

{
    "name":"normal",
    "bandwidth_limit":10,
    "transfer_limit":2,
}

Response Example:

{
    "success": true,
    "data": {
        "id": 48,
        "name": "normal",
        "node": 29,
        "password": "Q1333",
        "is_active": true,
        "bandwidth_limit": 10,
        "upload_transfer": 0,
        "download_transfer": 0,
        "transfer_limit": 0,
        "share_code": null,
        "transfer_is_monthly": false,
        "updated_at": "2025-02-17 13:51:16",
        "created_at": "2025-02-17 13:51:16"
    },
    "error": null
}

Delete Password

DELETE /api/v2/nodes/{node_id}/passwords/{password_id}/

Delete a specific password. Use this to immediately revoke access when needed.

Response:

{
  "success": true,
  "data": null,
  "error": null
}

Update Password

PUT /api/v2/nodes/{node_id}/passwords/{password_id}/

Update an existing password's expiration time or description.

Request Body:

{
    "name":"New Name",
    "bandwidth_limit":1
}

Response Example:

{
    "success": true,
    "data": {
        "id": 48,
        "name": "New Name",
        "node": 29,
        "password": "Q1333",
        "is_active": true,
        "bandwidth_limit": 1,
        "upload_transfer": 36035079,
        "download_transfer": 602186853,
        "transfer_limit": 2,
        "share_code": null,
        "transfer_is_monthly": false,
        "updated_at": "2025-02-17 13:53:09",
        "created_at": "2025-02-17 06:08:35"
    },
    "error": null
}