Backend API

This documentation is outdated

See also: The backend documentation

API Cheat sheet

With authentication:

πŸ”MethodEndpointDescription
πŸ”POST/modelsCreates model
πŸ”GET/models/:handleRead model
πŸ”PUT/models/:handleUpdate model
πŸ”DELETE/models/:handleRemove model
πŸ”POST/recipesCreate recipe
πŸ”GET/recipes/:handleRead recipe
πŸ”PUT/recipes/:handleUpdates recipe
πŸ”DELETE/recipes/:handleRemove recipe
πŸ”GET/accountLoad account
πŸ”PUT/accountUpdate account
πŸ”DELETE/accountRemove account
πŸ”POST/account/change/emailConfirm email change
πŸ”GET/account/exportExport account
πŸ”GET/account/restrictRestric account
πŸ”GET/users/:usernameRead user profile
πŸ”POST/available/usernameIs username available

Without authentication:

πŸ”“MethodEndpointDescription
πŸ”“POST/signupRequest account
πŸ”“POST/accountCreate account
πŸ”“POST/loginLog in
πŸ”“POST/reset/passwordRecover password
πŸ”“POST/confirm/loginPasswordless login
πŸ”“POST/oauth/initOauth initialisation
πŸ”“GET/oauth/callback/from/:providerOauth callback
πŸ”“POST/oauth/loginOauth login
πŸ”“GET/patronsPatron list
Further reading