Skip to content

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

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

Retrieve all passwords associated with a specific node.

Response Example:

json
{
    "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:

FieldTypeDescription
idIntegerUnique identifier for the password
nameStringName to distinguish different passwords (e.g., normal user, VIP user)
nodeIntegerID of the server this password belongs to
passwordStringPassword used for connection
is_activeBooleanWhether the password is enabled. When disabled, the password cannot be used
bandwidth_limitIntegerBandwidth limit in MB/s. Available values: 1, 5, 10, 20, 50
upload_transferIntegerTotal upload traffic in bytes
download_transferIntegerTotal download traffic in bytes
transfer_limitIntegerTraffic limit in GB. 0 means no limit
share_codeStringUnique code for sharing the password. Used in share links
transfer_is_monthlyBooleanWhether the traffic limit resets monthly
updated_atStringLast update time
created_atStringCreation time

Create Password

http
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:

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

Response Example:

json
{
    "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

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

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

Response:

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

Update Password

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

Update an existing password's expiration time or description.

Request Body:

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

Response Example:

json
{
    "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
}