mStream/docs/API/login.md
2017-10-26 17:44:55 -04:00

525 B

Login

Use this to get a token that can be used to access the rest of the API

  • URL

    /login

  • Method:

    POST

  • JSON Params

    Required:

    username
    password

  • JSON Example

    {
      'username': 'root',
      'password': 'qwerty'
    }
    
  • Success Response:

    {
      success: true,
      message: 'Welcome To mStream',
      vpaths: ['path1', 'path2'],
      token: 'REALLY LONG STRING'
    }
    
  • Error Response:

    All errors forward to /login-failed