Log in

Create an API session for use with API endpoints that require authentication.

POST /login/

cURL

cURL

curl --request POST \
  --url https://localhost/api/v2/login/ \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'password=<string>' \
  --data 'username=<string>'

200

{
  "session": "<string>"
}

Body

application/x-www-form-urlencoded

Credentials for login.

password · string · required

username · string · required

Response

200

application/json

Login response.

session · string

Session string for a valid API session. Specify this in header for any API requests that require authentication.