diff --git a/API.md b/API.md index 065d018..bfb6c54 100644 --- a/API.md +++ b/API.md @@ -12,7 +12,7 @@ All requests require an OAuth3 token in the request headers. ## Tunnel ### Check Status - * **URL** `/api/goldillocks@daplie.com/tunnel` + * **URL** `/api/goldilocks@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. @@ -21,7 +21,7 @@ All requests require an OAuth3 token in the request headers. checking the status. ### Start Tunnel - * **URL** `/api/goldillocks@daplie.com/tunnel` + * **URL** `/api/goldilocks@daplie.com/tunnel` * **Method** `POST` 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 ### Check Status - * **URL** `/api/goldillocks@daplie.com/socks5` + * **URL** `/api/goldilocks@daplie.com/socks5` * **Method** `GET` * **Response**: The returned object will have up to two values inside * `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 ### Start Proxy - * **URL** `/api/goldillocks@daplie.com/socks5` + * **URL** `/api/goldilocks@daplie.com/socks5` * **Method** `POST` * **Response**: Same response as for the `GET` resquest ### Stop Proxy - * **URL** `/api/goldillocks@daplie.com/socks5` + * **URL** `/api/goldilocks@daplie.com/socks5` * **Method** `DELETE` * **Response**: Same response as for the `GET` resquest