API Reference

Authorization: Bearer <api_key>

authorization: Bearer <api_key>

https://your-node-address:port/

Content-Type: application/x-protobuf

message Backend {
  BackendType type;      // Backend type (XRAY = 0)
  string config;         // Backend configuration
  repeated User users;   // List of users
  uint64 keepAlive;      // Keep alive duration in seconds
}

message User {
  string email;           // User's unique email identifier
  Proxy proxies;          // Proxy configurations
  repeated string inbounds; // List of inbound tags
}

message StatRequest {
  string name;      // User email or inbound/outbound tag
  bool reset;       // Reset traffic stats after retrieval
  StatType type;    // Type of stats to retrieve
}

enum StatType {
  Outbounds = 0;   // All outbound stats
  Outbound = 1;    // Single outbound stats
  Inbounds = 2;    // All inbound stats
  Inbound = 3;     // Single inbound stats
  UsersStat = 4;   // All users stats
  UserStat = 5;    // Single user stats
}

message BaseInfoResponse {
  string version;
  string core_type;
  bool running;
}

message Log {
  string detail;  // Log message
}

message SystemStatsResponse {
  uint64 mem_total;                  // Total memory
  uint64 mem_used;                   // Used memory
  uint64 cpu_cores;                  // CPU cores
  double cpu_usage;                  // CPU usage %
  uint64 incoming_bandwidth_speed;   // Download speed
  uint64 outgoing_bandwidth_speed;   // Upload speed
}

message BackendStatsResponse {
  uint32 num_goroutine;    // Active goroutines
  uint32 num_gc;           // GC runs
  uint64 alloc;            // Allocated memory
  uint64 total_alloc;      // Total allocated
  uint64 sys;              // System memory
  uint64 mallocs;          // Malloc count
  uint64 frees;            // Free count
  uint64 live_objects;     // Live objects
  uint64 pause_total_ns;   // Total GC pause
  uint32 uptime;           // Uptime in seconds
}

StatRequest {
  type: UsersStat,
  reset: false
}

StatRequest {
  name: "user@example.com",
  type: UserStat,
  reset: true  // Reset after retrieval
}

message StatResponse {
  repeated Stat stats;
}

message Stat {
  string name;   // User email or tag
  string type;   // Stat type
  string link;   // Link identifier
  int64 value;   // Traffic value in bytes
}

message OnlineStatResponse {
  string name;   // User email
  int64 value;   // Online connection count
}

{
  "error": "Error description",
  "code": "ERROR_CODE"
}