Core

Core

/docs/

Supported actions and methods:

/docs/

Methods: GET

/api/version/

Retrieve version of the application

Supported actions and methods:

/api/version/

Methods: GET

Retrieve version of the application

/api/

Supported actions and methods:

/api/

Methods: GET

/api-auth/password/

Api view loosely based on DRF’s default ObtainAuthToken, but with the responses formats and status codes aligned with BasicAuthentication behavior.

Valid request example:

POST /api-auth/password/ HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

{
    "username": "alice",
    "password": "$ecr3t"
}

Success response example:

HTTP/1.0 200 OK
Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept, Cookie

{
    "token": "c84d653b9ec92c6cbac41c706593e66f567a7fa4"
}

Field validation failure response example:

HTTP/1.0 401 UNAUTHORIZED
Allow: POST, OPTIONS
Content-Type: application/json

{
    "password": ["This field is required."]
}

Invalid credentials failure response example:

HTTP/1.0 401 UNAUTHORIZED
Allow: POST, OPTIONS
Content-Type: application/json

{
    "detail": "Invalid username/password"
}

Supported actions and methods:

/api-auth/password/

Methods: POST

Supported fields for creation:

  • usernamestring
  • passwordstring

Api view loosely based on DRF’s default ObtainAuthToken, but with the responses formats and status codes aligned with BasicAuthentication behavior.

Valid request example:

POST /api-auth/password/ HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

{
    "username": "alice",
    "password": "$ecr3t"
}

Success response example:

HTTP/1.0 200 OK
Allow: POST, OPTIONS
Content-Type: application/json
Vary: Accept, Cookie

{
    "token": "c84d653b9ec92c6cbac41c706593e66f567a7fa4"
}

Field validation failure response example:

HTTP/1.0 401 UNAUTHORIZED
Allow: POST, OPTIONS
Content-Type: application/json

{
    "password": ["This field is required."]
}

Invalid credentials failure response example:

HTTP/1.0 401 UNAUTHORIZED
Allow: POST, OPTIONS
Content-Type: application/json

{
    "detail": "Invalid username/password"
}