BingoVPN

Appearance

Bingo VPN API Documentation ​

Overview ​

Welcome to the Bingo VPN API documentation. This API allows you to manage your VPN nodes, passwords, and organization settings programmatically.

Base URL ​

All API requests should be made to:

https://my.vpn.bingo

For example, to list all nodes, make a GET request to:

https://my.vpn.bingo/api/v2/nodes/

Authentication ​

Bingo VPN API uses token-based authentication. To access the API endpoints, you need to include your API token in the request headers.

Authentication ​

All API requests require authentication using an access token. Include your token in the Authorization header:

http
Authorization: Bearer your_token_here

Managing Access Tokens

Create and manage your API tokens in the Organization Settings page.

See our Authentication Guide for detailed information about token management and best practices.

Response Format ​

All API responses follow a unified format:

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

Success Response ​

For successful requests (HTTP 200, 201):

json
{
  "success": true,
  "data": {
    // Response data here
  },
  "error": null
}

For successful requests with no content (HTTP 204):

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

Error Response ​

For error responses:

json
{
  "success": false,
  "data": null,
  "error": {
    "code": 400,
    "message": "Error message here"
  }
}

Error messages are formatted in different ways depending on the type of error:

  • Single error message: Direct string message
  • Field validation errors: "field: error message"
  • Non-field errors: First error from the list

API Documentation ​

The API documentation is organized into the following sections:

Error Codes ​

The API uses standard HTTP response codes to indicate the success or failure of requests.

  • 200 OK: Request successful
  • 201 Created: Resource created successfully
  • 400 Bad Request: Invalid request parameters
  • 401 Unauthorized: Invalid or missing authentication token
  • 403 Forbidden: Valid token but insufficient permissions
  • 404 Not Found: Resource not found
  • 429 Too Many Requests: Rate limit exceeded
  • 500 Internal Server Error: Server error

Rate Limiting ​

API requests are rate limited to ensure fair usage. The current limits are:

  • 1000 requests per hour per token
  • 10 concurrent requests per token

Rate limit information is included in the response headers:

http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1676289600