jshaver/goldilocks.js
1
0
Fork 0
forked from coolaj86/goldilocks.js
Code Issues Pull Requests Releases Wiki Activity

added some simple docs for the tunnel API

Browse Source
This commit is contained in:
tigerbot 2017-08-09 18:30:18 -06:00
parent 66e9ecd2bf
commit b65697ea74
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
API.md
View File

@ -7,6 +7,26 @@ admin.invalid
localhost.admin.daplie.me
```
All requests require an OAuth3 token in the request headers.
## Tunnel
### Check Status
* **URL** `/api/goldillocks@daplie.com/tunnel`
* **Method** `POST`
* **Reponse**: An object whose keys are the URLs for the tunnels, and whose
properties are arrays of the tunnel tokens.
This route with return only the sessions started by the same user who is
checking the status.
### Start Tunnel
* **URL** `/api/goldillocks@daplie.com/tunnel`
* **Method** `POST`
This route will use the stored token for the user matching the request
header to request a tunnel token from the audience of the stored token.
## Socks5 Proxy
### Check Status