For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Api Auth

post

View to issue a token from username and password credentials.

Subclasses ObtainAuthToken so the endpoint keeps accepting JSON credentials and returning a "token" key, as the frontend and the agents expect, while the issued token is a knox one.

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Body
usernamestringWrite-onlyRequired
passwordstringWrite-onlyRequired
tokenstringRead-onlyRequired
Responses
200Success
application/json
usernamestringWrite-onlyRequired
passwordstringWrite-onlyRequired
tokenstringRead-onlyRequired
post/api-auth/token
POST /api-auth/token HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 37

"username='text'&password='text'"
200Success
{
  "token": "text"
}
post
Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
formatstring · enumOptionalPossible values:
Responses
200

No response body

No content

post/api-auth/token/logout
POST /api-auth/token/logout HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
200

No response body

No content

Last updated