Home

Authentication API

/signIn

Authenticates your API session and gets a token which you include in all requests in this session.

Whenever you start a new session, first send this request to generate a new token.

Tip

To reach Unravel Server you might need to open an SSH session to your cluster, cluster-name.

ssh@root cluster-name
Request
POST http://unravel-host:3000/api/v1/signIn
Path parameters

None.

Query parameters

Name

Type

Description

username

string

Your username

password

string

Your password

Response body

Name

Type

Description

message

string

Indicates success or failure.

token

string

The token which you will include in the Authorization header on all subsequent requests in this session.

role

string

 

readOnly

string

 

tags

string

id

string

username

string

Examples

Request:

curl -X GET "http://http://myserver.com:3000/api/v1/signIn" -H  "accept: application/json" -H  "content-type: application/x-www-form-urlencoded" -d "username=admin&password=your-password"

Response body:

{
  "message": "ok",
  "token": "long-string",
  "role": "admin",
  "readOnly": false,
  "tags": "",
  "id": "admin",
  "username": "admin"
}