Skip to main content
POST
/
v1
/
login
Authenticate user
curl --request POST \
  --url https://{sql-node}/v1/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "admin@system",
  "password": "admin",
  "database": "system"
}
'
{
  "access_token": "<token>",
  "username": "admin",
  "database": "system",
  "status": {
    "vendor_code": 0,
    "sql_state": "00000",
    "reason": "The operation completed successfully"
  }
}

Body

application/json
username
string
required

Username for authentication

password
string<password>
required

Password for the username

database
string

Target database name. Defaults to 'system' if not specified.

Response

Successful authentication

access_token
string

Authentication token for subsequent requests

username
string

Authenticated username

database
string

Connected database

status
object

Status information for API responses