package admin

Get desktop application:
View/edit binary Protocol Buffers messages

The AdminService is used for performing administrative actions with gServer, such as adding tunnels, configuring clients, and listing out the state of gServer.

• rpc ClientRegister (ClientRegisterRequest, ClientRegisterResponse)

  admin.proto:16

  Generates a configred gClient executable

  message ClientRegisterRequest

  admin.proto:56

  • string client_id = 1

  • string token = 2

  • string server_endpoint = 3

  • uint32 port = 4

  • string platform = 5

  • string bin_type = 6

  • string arch = 7

  • string proxyServer = 8

  message ClientRegisterResponse

  admin.proto:67

  • string error = 1

• rpc ClientDisconnect (ClientDisconnectRequest, ClientDisconnectResponse)

  admin.proto:19

  Disconnects a client from the server

  message ClientDisconnectRequest

  admin.proto:71

  • string client_id = 1

  message ClientDisconnectResponse

  admin.proto:75

  (message has no fields)

• rpc ClientList (ClientListRequest, stream Client)

  admin.proto:22

  Lists all connected gClients

  message ClientListRequest

  admin.proto:77

  (message has no fields)

  message Client

  admin.proto:47

  • string name = 1

  • string client_id = 2

  • uint32 status = 3

  • string remote_address = 4

  • string connect_date = 5

  • string hostname = 6

• rpc ConnectionList (ConnectionListRequest, stream Connection)

  admin.proto:25

  List all connections for a tunnel

  message ConnectionListRequest

  admin.proto:86

  • string client_id = 1

  • string tunnel_id = 2

  message Connection

  admin.proto:79

  • uint32 source_ip = 1

  • uint32 source_port = 2

  • uint32 destination_ip = 3

  • uint32 destination_port = 4

• rpc SocksStart (SocksStartRequest, SocksStartResponse)

  admin.proto:28

  Starts a SocksV5 server on a gClient

  message SocksStartRequest

  admin.proto:91

  • string client_id = 1

  • uint32 socks_port = 2

  message SocksStartResponse

  admin.proto:96

  (message has no fields)

• rpc SocksStop (SocksStopRequest, SocksStopResponse)

  admin.proto:31

  Stops a SocksV5 server on a gClient

  message SocksStopRequest

  admin.proto:98

  • string client_id = 1

  message SocksStopResponse

  admin.proto:102

  (message has no fields)

• rpc TunnelAdd (TunnelAddRequest, TunnelAddResponse)

  admin.proto:34

  Add a tunnel

  message TunnelAddRequest

  admin.proto:113

  • string client_id = 1

  • optional Tunnel tunnel = 2

  message TunnelAddResponse

  admin.proto:118

  (message has no fields)

• rpc TunnelDelete (TunnelDeleteRequest, TunnelDeleteResponse)

  admin.proto:37

  Delete a tunnel

  message TunnelDeleteRequest

  admin.proto:120

  • string client_id = 1

  • string tunnel_id = 2

  message TunnelDeleteResponse

  admin.proto:125

  (message has no fields)

• rpc TunnelList (TunnelListRequest, stream Tunnel)

  admin.proto:40

  List all tunnels for an endppoint

  message TunnelListRequest

  admin.proto:127

  • string client_id = 1

• bytes data = 1

Used as response type in: AdminService.TunnelList

Used as field type in: TunnelAddRequest

• string id = 1

• uint32 direction = 2

• uint32 listen_ip = 3

• uint32 listen_port = 4

• uint32 destination_ip = 5

• uint32 destination_port = 6