coolaj86/goldilocks.js
1
0
Fork 1
Code Issues Pull Requests Releases Activity

Update API.md

Browse Source
This commit is contained in:
Drew Warren 2017-08-10 10:41:16 -06:00
parent b65697ea74
commit 42adabdb20
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
API.md
View File

@ -12,7 +12,7 @@ All requests require an OAuth3 token in the request headers.
## Tunnel ## Tunnel
### Check Status ### Check Status
* **URL** `/api/goldillocks@daplie.com/tunnel` * **URL** `/api/goldilocks@daplie.com/tunnel`
* **Method** `POST` * **Method** `POST`
* **Reponse**: An object whose keys are the URLs for the tunnels, and whose * **Reponse**: An object whose keys are the URLs for the tunnels, and whose
properties are arrays of the tunnel tokens. properties are arrays of the tunnel tokens.
@ -21,7 +21,7 @@ All requests require an OAuth3 token in the request headers.
checking the status. checking the status.
### Start Tunnel ### Start Tunnel
* **URL** `/api/goldillocks@daplie.com/tunnel` * **URL** `/api/goldilocks@daplie.com/tunnel`
* **Method** `POST` * **Method** `POST`
This route will use the stored token for the user matching the request This route will use the stored token for the user matching the request
@ -30,18 +30,18 @@ All requests require an OAuth3 token in the request headers.
## Socks5 Proxy ## Socks5 Proxy
### Check Status ### Check Status
* **URL** `/api/goldillocks@daplie.com/socks5` * **URL** `/api/goldilocks@daplie.com/socks5`
* **Method** `GET` * **Method** `GET`
* **Response**: The returned object will have up to two values inside * **Response**: The returned object will have up to two values inside
* `running`: boolean value to indicate if the proxy is currently active * `running`: boolean value to indicate if the proxy is currently active
* `port`: if the proxy is running this is the port it's running on * `port`: if the proxy is running this is the port it's running on
### Start Proxy ### Start Proxy
* **URL** `/api/goldillocks@daplie.com/socks5` * **URL** `/api/goldilocks@daplie.com/socks5`
* **Method** `POST` * **Method** `POST`
* **Response**: Same response as for the `GET` resquest * **Response**: Same response as for the `GET` resquest
### Stop Proxy ### Stop Proxy
* **URL** `/api/goldillocks@daplie.com/socks5` * **URL** `/api/goldilocks@daplie.com/socks5`
* **Method** `DELETE` * **Method** `DELETE`
* **Response**: Same response as for the `GET` resquest * **Response**: Same response as for the `GET` resquest