v1.0 Stable

API Reference

Build custom integrations with the RamOnly API. Manage connections, retrieve server information, and automate your VPN workflow.

Base URL

https://api.ramonly.io

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer your_access_token

Obtain your API token from the Dashboard → Settings → API Keys.

Rate Limits

1000

Requests per hour

100

Requests per minute

Rate limit headers are included in all responses: X-RateLimit-Remaining

Endpoints

POST /v1/auth/login

Authenticate and receive access token

POST /v1/auth/refresh

Refresh an expired access token

GET /v1/servers

List all available VPN servers

GET /v1/servers/{id}

Get details for a specific server

POST /v1/connections

Generate WireGuard configuration

DELETE /v1/connections/{id}

Revoke a connection configuration

GET /v1/account

Get current account information

GET /v1/account/usage

Get bandwidth usage statistics

Example Request

curl -X GET https://api.ramonly.io/v1/servers \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json"

Response

{
  "servers": [
    {
      "id": "us-east-1",
      "name": "New York",
      "country": "US",
      "load": 23,
      "latency_ms": 8,
      "status": "operational"
    },
    ...
  ],
  "total": 50
}

Official SDKs

We provide official client libraries for popular languages:

Python Soon Node.js Soon Go Soon Rust Soon