Skip to content

Latest commit

 

History

History
267 lines (186 loc) · 6.41 KB

Socks5ServerApi.md

File metadata and controls

267 lines (186 loc) · 6.41 KB
Raw

Socks5ServerApi

All URIs are relative to http://127.0.0.1:18776/api/v1/module

Method HTTP request Description
addSocks5Server POST /socks5-server add socks5-server
describeSocks5Server GET /socks5-server/{socks5}/detail get detailed info of one socks5-server
getSocks5Server GET /socks5-server/{socks5} get socks5-server
listSocks5Server GET /socks5-server retrieve socks5-server list
removeSocks5Server DELETE /socks5-server/{socks5} remove socks5-server
updateSocks5Server PUT /socks5-server/{socks5} update socks5-server

addSocks5Server

addSocks5Server(body)

add socks5-server

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.Socks5ServerApi;


Socks5ServerApi apiInstance = new Socks5ServerApi();
Socks5ServerCreate body = new Socks5ServerCreate(); // Socks5ServerCreate | 
try {
    apiInstance.addSocks5Server(body);
} catch (ApiException e) {
    System.err.println("Exception when calling Socks5ServerApi#addSocks5Server");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body Socks5ServerCreate

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

describeSocks5Server

Socks5ServerDetail describeSocks5Server(socks5)

get detailed info of one socks5-server

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.Socks5ServerApi;


Socks5ServerApi apiInstance = new Socks5ServerApi();
String socks5 = "socks5_example"; // String | name of the socks5-server
try {
    Socks5ServerDetail result = apiInstance.describeSocks5Server(socks5);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling Socks5ServerApi#describeSocks5Server");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
socks5 String name of the socks5-server

Return type

Socks5ServerDetail

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getSocks5Server

Socks5Server getSocks5Server(socks5)

get socks5-server

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.Socks5ServerApi;


Socks5ServerApi apiInstance = new Socks5ServerApi();
String socks5 = "socks5_example"; // String | name of the socks5-server
try {
    Socks5Server result = apiInstance.getSocks5Server(socks5);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling Socks5ServerApi#getSocks5Server");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
socks5 String name of the socks5-server

Return type

Socks5Server

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listSocks5Server

List<Socks5Server> listSocks5Server()

retrieve socks5-server list

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.Socks5ServerApi;


Socks5ServerApi apiInstance = new Socks5ServerApi();
try {
    List<Socks5Server> result = apiInstance.listSocks5Server();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling Socks5ServerApi#listSocks5Server");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<Socks5Server>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeSocks5Server

removeSocks5Server(socks5)

remove socks5-server

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.Socks5ServerApi;


Socks5ServerApi apiInstance = new Socks5ServerApi();
String socks5 = "socks5_example"; // String | name of the socks5-server
try {
    apiInstance.removeSocks5Server(socks5);
} catch (ApiException e) {
    System.err.println("Exception when calling Socks5ServerApi#removeSocks5Server");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
socks5 String name of the socks5-server

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateSocks5Server

updateSocks5Server(socks5, body)

update socks5-server

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.Socks5ServerApi;


Socks5ServerApi apiInstance = new Socks5ServerApi();
String socks5 = "socks5_example"; // String | name of the socks5-server
Socks5ServerUpdate body = new Socks5ServerUpdate(); // Socks5ServerUpdate | 
try {
    apiInstance.updateSocks5Server(socks5, body);
} catch (ApiException e) {
    System.err.println("Exception when calling Socks5ServerApi#updateSocks5Server");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
socks5 String name of the socks5-server
body Socks5ServerUpdate

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json