mStream/docs/API/ping.md
2017-03-03 12:46:02 -05:00

27 lines
377 B
Markdown

**Ping**
----
Used to check if the user is logged in. Also used to get the vPath
* **URL**
/ping
* **Method:**
`GET`
* **Success Response:**
```
{
vPath: 'REALLY LONG STRING',
guest: false
}
```
Returns whether user is a guest or not. Guest accounts don't have write access
* **Error Response:**
Forwards to `/login-failed` if not logged in