API Reference

curl -X POST https://setup.doxx.net \
  -d "auth=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "message": "Authentication successful"
}

{
  "status": "error",
  "message": "Missing authentication token"
}

{
  "status": "error",
  "message": "Invalid authentication token"
}

curl -X POST https://setup.doxx.net \
  -d "create_account=1"

{
  "status": "success",
  "action": "account_created",
  "token": "dGhpc2lzYXRlc3R0b2tlbmZvcmRveHhuZXQ",
  "welcome_message": "Your account has been created successfully!",
  "security_notes": [
    "doxx.net does not use usernames or passwords and does not store your email or other personal account data.",
    "Your token is unique to you and is the only way to access your account. Do not share it with anyone.",
    "Store it securely: write it down, take a photo, and save it in a password manager or secure notes.",
    "On your first login, your browser may prompt you to save it in your password wallet — accept this to avoid losing it.",
    "Anyone with this token has full access to your account. Treat it like a password."
  ],
  "usage_info": [
    "Web: visit https://a0x13.doxx.net and paste your token to sign in.",
    "API: include your token as the 'token' parameter in POST requests to https://setup.doxx.net"
  ]
}

curl -X POST https://setup.doxx.net \
  -d "delete_account=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "message": "Account deleted successfully"
}

curl -X POST https://setup.doxx.net \
  -d "create_tunnel=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "type=wireguard" \
  -d "name=My VPN Tunnel" \
  -d "server=newyork-us" \
  -d "bandwidth_stats=1" \
  -d "security_stats=1" \
  -d "auto_reconnect=1"

{
  "status": "success",
  "message": "Tunnel created successfully",
  "tunnel_token": "dGVzdHR1bm5lbHRva2VuZm9yZG94eG5ldA",
  "assigned_ip": "10.42.15.200/31",
  "assigned_v6": "2602:f5c1:1::af5:fad6/127",
  "public_key": "wg_public_key_here",
  "private_key": "wg_private_key_here"
}

{
  "status": "error",
  "message": "Invalid tunnel type specified"
}

{
  "status": "error",
  "message": "Tunnel name must be 64 characters or less"
}

curl -X POST https://setup.doxx.net \
  -d "update_tunnel=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_token=TUNNEL_TOKEN_HERE" \
  -d "name=Updated Tunnel Name" \
  -d "bandwidth_stats=1" \
  -d "block_bad_dns=1"

{
  "status": "success",
  "message": "Tunnel updated successfully"
}

curl -X POST https://setup.doxx.net \
  -d "list_tunnels=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "include_proxy_configs=1"

{
  "status": "success",
  "tunnels": [
    {
      "tunnel_token": "dGVzdHR1bm5lbA",
      "type": "wireguard",
      "name": "My Primary VPN",
      "server": "newyork-us",
      "assigned_ip": "10.42.15.200/31",
      "assigned_v6": "2602:f5c1:1::af5:fad6/127",
      "public_key": "wg_public_key_here",
      "private_key": "wg_private_key_here",
      "bandwidth_stats": 1,
      "security_stats": 1,
      "block_bad_dns": 1,
      "keep_established_ssh": 0,
      "kill_default_route": 0,
      "auto_reconnect": 1,
      "enable_routing": 1,
      "snarf_dns": 1,
      "firewall": 0,
      "ipv6_enabled": 1,
      "created_at": "2024-01-15 10:30:00",
      "active": 1,
      "is_connected": true,
      "connection_status": "connected",
      "proxy_config": {
        "enabled": true,
        "location": "newyork-us",
        "browser": "chrome",
        "custom_lat": null,
        "custom_lon": null,
        "custom_timezone": null,
        "custom_language": null
      }
    }
  ]
}

curl -X POST https://setup.doxx.net \
  -d "delete_tunnel=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_token=TUNNEL_TOKEN" \
  -d "type=wireguard" \
  -d "assigned_ip=10.42.15.200/31"

{
  "status": "success",
  "message": "Tunnel deleted successfully"
}

curl -X POST https://setup.doxx.net \
  -d "wireguard=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_token=TUNNEL_TOKEN"

{
  "status": "success",
  "config": {
    "client": {
      "private_key": "client_private_key_base64",
      "address": "10.42.15.201/31",
      "address_v6": "2602:f5c1:1::af5:fad7/127",
      "dns": "10.42.15.200, 2602:f5c1:1::af5:fad6"
    },
    "server": {
      "public_key": "server_public_key_base64",
      "endpoint": "newyork-us.doxx.net:51820",
      "allowed_ips": "0.0.0.0/0, ::/0",
      "persistent_keepalive": 25
    }
  }
}

curl -X POST https://setup.doxx.net \
  -d "servers=1" \
  -d "type=wireguard"

{
  "status": "success",
  "servers": [
    {
      "server_name": "newyork-us",
      "type": "wireguard",
      "location": "New York, USA",
      "description": "Primary US East Coast server",
      "public_key": "server_wireguard_public_key_base64"
    },
    {
      "server_name": "london-uk",
      "type": "wireguard",
      "location": "London, UK",
      "description": "Primary UK server",
      "public_key": "server_wireguard_public_key_base64"
    }
  ]
}

curl -X POST https://setup.doxx.net \
  -d "create_domain=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite"

{
  "status": "success",
  "message": "Domain 'mysite.doxx' created successfully",
  "domain": "mysite.doxx",
  "domain_id": 12345
}

{
  "status": "error",
  "message": "Only .doxx domains are allowed. Your domain will be: example.doxx"
}

{
  "status": "error",
  "message": "Domain already exists"
}

{
  "status": "error",
  "message": "This domain is reserved: <reason>. If you would like to register this domain, please discuss with the team on Discord: https://discord.gg/Gr9rByrEzZ"
}

curl -X POST https://setup.doxx.net \
  -d "list_domains=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "domains": [
    {
      "name": "mysite.doxx",
      "id": 12345
    },
    {
      "name": "another.doxx",
      "id": 12346
    }
  ]
}

curl -X POST https://setup.doxx.net \
  -d "delete_domain=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx"

{
  "status": "success",
  "message": "Domain deleted successfully"
}

curl -X POST https://setup.doxx.net \
  -d "create_dns_record=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx" \
  -d "name=www" \
  -d "type=A" \
  -d "content=203.0.113.1" \
  -d "ttl=3600"

curl -X POST https://setup.doxx.net \
  -d "create_dns_record=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx" \
  -d "name=_sip._tcp" \
  -d "type=SRV" \
  -d "srv_priority=10" \
  -d "srv_weight=60" \
  -d "srv_port=5060" \
  -d "srv_target=sipserver.mysite.doxx"

curl -X POST https://setup.doxx.net \
  -d "create_dns_record=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx" \
  -d "name=1.0.168.192.in-addr.arpa" \
  -d "type=PTR" \
  -d "content=server1.mysite.doxx"

{
  "status": "success",
  "message": "DNS record created successfully"
}

{
  "status": "error",
  "message": "Invalid record type. Allowed types are: A, AAAA, CNAME, MX, TXT, NS, SRV, PTR"
}

{
  "status": "error",
  "message": "You do not have permission to modify this domain"
}

{
  "status": "error",
  "message": "You do not own the IP address in this PTR record"
}

curl -X POST https://setup.doxx.net \
  -d "list_dns=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx"

{
  "status": "success",
  "records": [
    {
      "name": "mysite.doxx",
      "type": "SOA",
      "content": "ns1.doxx.net. hostmaster.doxx.net. 1 10800 3600 604800 3600",
      "ttl": 3600,
      "prio": 0
    },
    {
      "name": "mysite.doxx",
      "type": "NS",
      "content": "ns1.doxx.net.",
      "ttl": 3600,
      "prio": 0
    },
    {
      "name": "www.mysite.doxx",
      "type": "A",
      "content": "203.0.113.1",
      "ttl": 3600,
      "prio": 0
    }
  ]
}

curl -X POST https://setup.doxx.net \
  -d "update_dns_record=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx" \
  -d "old_name=www.mysite.doxx" \
  -d "old_type=A" \
  -d "old_content=203.0.113.1" \
  -d "new_content=203.0.113.2" \
  -d "new_ttl=7200"

{
  "status": "success",
  "message": "DNS record updated successfully"
}

curl -X POST https://setup.doxx.net \
  -d "delete_dns_record=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx" \
  -d "name=www.mysite.doxx" \
  -d "type=A" \
  -d "content=203.0.113.1"

{
  "status": "success",
  "message": "DNS record deleted successfully"
}

curl -X POST https://setup.doxx.net \
  -d "sign_certificate=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "domain=mysite.doxx" \
  --data-urlencode "csr=$(cat domain.csr)"

{
  "status": "success",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIFXTCCBEWgAwIBAgISBNdz...\n-----END CERTIFICATE-----",
  "message": "Certificate signed successfully for *.mysite.doxx",
  "domain": "*.mysite.doxx"
}

{
  "status": "error",
  "message": "Access denied: You do not own the domain 'example.doxx'"
}

{
  "status": "error",
  "message": "Invalid CSR: Could not extract certificate request content"
}

curl -X POST https://setup.doxx.net \
  -d "firewall_rule_add=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_token=SOURCE_TUNNEL_TOKEN" \
  -d "protocol=TCP" \
  -d "src_ip=10.42.15.200/31" \
  -d "src_port=ALL" \
  -d "dst_ip=10.42.20.100/31" \
  -d "dst_port=443" \
  -d "enabled=1"

{
  "status": "success",
  "message": "Firewall rule added successfully"
}

{
  "status": "error",
  "message": "Cannot create 1:1 firewall links when 'Link All Tunnels' is enabled. Please disable it first."
}

{
  "status": "error",
  "message": "Source IP does not belong to your account"
}

curl -X POST https://setup.doxx.net \
  -d "firewall_rule_delete=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_token=SOURCE_TUNNEL_TOKEN" \
  -d "protocol=TCP" \
  -d "src_ip=10.42.15.200/31" \
  -d "src_port=ALL" \
  -d "dst_ip=10.42.20.100/31" \
  -d "dst_port=443"

{
  "status": "success",
  "message": "Firewall rule deleted successfully"
}

curl -X POST https://setup.doxx.net \
  -d "firewall_rule_list=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_token=TUNNEL_TOKEN"

{
  "status": "success",
  "rules": [
    {
      "tunnel_token": "SOURCE_TUNNEL_TOKEN",
      "protocol": "TCP",
      "src_ip": "10.42.15.200/31",
      "src_port": "ALL",
      "dst_ip": "10.42.20.100/31",
      "dst_port": "443",
      "enabled": 1
    }
  ]
}

curl -X POST https://setup.doxx.net \
  -d "firewall_link_all_toggle=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "enabled=1"

{
  "status": "success",
  "message": "Link all tunnels enabled successfully"
}

curl -X POST https://setup.doxx.net \
  -d "firewall_link_all_status=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "link_all_tunnels": 1
}

curl -X POST https://setup.doxx.net \
  -d "get_proxy_config=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_ip=10.42.15.200/31"

{
  "status": "success",
  "config": {
    "enabled": true,
    "location": "newyork-us",
    "browser": "chrome",
    "custom_lat": 40.7128,
    "custom_lon": -74.0060,
    "custom_timezone": "America/New_York",
    "custom_language": "en-US"
  }
}

{
  "status": "success",
  "config": {
    "enabled": false,
    "location": "newyork-us",
    "browser": "",
    "custom_lat": null,
    "custom_lon": null,
    "custom_timezone": null,
    "custom_language": null
  }
}

curl -X POST https://setup.doxx.net \
  -d "update_proxy_config=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tunnel_ip=10.42.15.200/31" \
  -d "enabled=true" \
  -d "location=newyork-us" \
  -d "browser=chrome" \
  -d "custom_lat=40.7128" \
  -d "custom_lon=-74.0060"

{
  "status": "success",
  "message": "Proxy configuration updated successfully"
}

curl -X POST https://setup.doxx.net \
  -d "get_profile=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "profile": {
    "recovery_email": "[email protected]",
    "recovery_phone": "+1234567890",
    "email_notifications": 1,
    "sms_notifications": 0,
    "created_at": "2024-01-15 10:30:00",
    "updated_at": "2024-01-20 14:45:00"
  },
  "recovery_codes_count": 8
}

{
  "status": "success",
  "profile": {
    "recovery_email": null,
    "recovery_phone": null,
    "email_notifications": 0,
    "sms_notifications": 0,
    "created_at": null,
    "updated_at": null
  },
  "recovery_codes_count": 0
}

curl -X POST https://setup.doxx.net \
  -d "update_profile=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "[email protected]" \
  -d "email_notifications=1"

{
  "status": "success",
  "message": "Profile updated successfully"
}

curl -X POST https://setup.doxx.net \
  -d "create_account_recovery=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "message": "Recovery codes generated successfully",
  "codes": [
    "ABCD-EFGH-JKLM-NPQR",
    "1234-5678-90AB-CDEF",
    "AAAA-BBBB-CCCC-DDDD",
    "1111-2222-3333-4444",
    "FFFF-EEEE-DDDD-CCCC",
    "9876-5432-1098-7654",
    "AABC-DDEF-GHIJ-KLMN",
    "1A2B-3C4D-5E6F-7G8H",
    "ZZZZ-YYYY-XXXX-WWWW",
    "0000-1111-2222-3333"
  ],
  "set_id": "a1b2c3d4e5f6789012345678901234567890abcd",
  "created_at": "2024-01-20 15:30:00"
}

curl -X POST https://setup.doxx.net \
  -d "verify_account_recovery=1" \
  -d "recovery_code=ABCD-EFGH-JKLM-NPQR"

{
  "status": "success",
  "message": "Recovery code verified successfully",
  "token": "dGhpc2lzYXRlc3R0b2tlbmZvcmRveHhuZXQ"
}

{
  "status": "error",
  "message": "Invalid or already used recovery code"
}

curl -X POST https://setup.doxx.net \
  -d "tos_status=1" \
  -d "token=YOUR_TOKEN_HERE"

{
  "status": "success",
  "tos_accepted": true,
  "accepted_at": "2024-01-15 10:30:00",
  "version": "1.0"
}

{
  "status": "success",
  "tos_accepted": false,
  "current_version": "1.0"
}

curl -X POST https://setup.doxx.net \
  -d "accept_tos=1" \
  -d "token=YOUR_TOKEN_HERE" \
  -d "tos_version=1.0"

{
  "status": "success",
  "message": "Terms of Service accepted successfully"
}

{
  "status": "error",
  "message": "Description of the error"
}

{
  "status": "error",
  "message": "Missing authentication token"
}

{
  "status": "error",
  "message": "Invalid authentication token"
}

{
  "status": "error",
  "message": "Missing required parameter: <parameter_name>"
}

{
  "status": "error",
  "message": "Invalid <parameter_name> specified"
}

{
  "status": "error",
  "message": "Access denied: You do not have permission to <action>"
}

{
  "status": "error",
  "message": "Tunnel not found or access denied"
}

{
  "status": "error",
  "message": "<Resource> not found"
}

{
  "status": "error",
  "message": "<Resource> already exists"
}

{
  "status": "error",
  "message": "Database connection error"
}

{
  "status": "error",
  "message": "Internal server error"
}

import requests

url = "https://setup.doxx.net"
data = {
    "create_tunnel": "1",
    "token": "YOUR_TOKEN_HERE",
    "type": "wireguard",
    "name": "My VPN",
    "server": "newyork-us",
    "bandwidth_stats": "1"
}

response = requests.post(url, data=data)
print(response.json())

const url = "https://setup.doxx.net";
const formData = new FormData();
formData.append("list_tunnels", "1");
formData.append("token", "YOUR_TOKEN_HERE");

fetch(url, {
    method: "POST",
    body: formData
})
.then(response => response.json())
.then(data => console.log(data));

curl -X POST https://setup.doxx.net \
  -d "auth=1" \
  -d "token=YOUR_TOKEN_HERE"