Auth
Login, password change, 2FA setup and admin/setup bootstrap
Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Response Body
curl -X DELETE "https://example.com/api/v1/auth/2fa"Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Response Body
application/json
curl -X POST "https://example.com/api/v1/auth/2fa/setup"{ "secret": "string", "qr_code": "string", "url": "string"}Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Response Body
application/json
curl -X GET "https://example.com/api/v1/auth/2fa/status"{ "enabled": true}Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/api/v1/auth/2fa/verify" \ -H "Content-Type: application/json" \ -d '{ "code": "string" }'Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/auth/login" \ -H "Content-Type: application/json" \ -d '{ "username": "string", "password": "string" }'{ "token": "string", "user": { "id": "string", "username": "string" }}Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/auth/login/2fa" \ -H "Content-Type: application/json" \ -d '{ "code": "string" }'{ "token": "string", "user": { "id": "string", "username": "string" }}Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Response Body
curl -X POST "https://example.com/api/v1/auth/logout"Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Response Body
application/json
curl -X GET "https://example.com/api/v1/auth/me"{ "id": "string", "username": "string", "avatar_url": "string"}Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X PUT "https://example.com/api/v1/auth/password" \ -H "Content-Type: application/json" \ -d '{ "current_password": "string", "new_password": "stringst" }'Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
curl -X POST "https://example.com/api/v1/auth/setup" \ -H "Content-Type: application/json" \ -d '{ "username": "string", "password": "stringst" }'curl -X GET "https://example.com/api/v1/auth/status"{ "initialized": true}Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
Response Body
curl -X DELETE "https://example.com/api/v1/auth/me/avatar"Authorization
bearerAuth Pass an API token obtained from POST /api/v1/auth/login or POST /api/v1/api-tokens. Tokens have the prefix mlml_.
In: header
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/auth/me/avatar" \ -H "Content-Type: application/json" \ -d '{}'{ "avatar_url": "string"}Path Parameters
Query Parameters
512Value in
- 128
- 512
Cache buster, ignored
Response Body
image/jpeg
curl -X GET "https://example.com/api/v1/users/string/avatar""string"