• Production Security Concerns
• Login
  • postLogin with REST API
  • postRegister with REST API

API docs by Redocly

Wekan REST API (v8.98)

Download OpenAPI specification:

The REST API allows you to control and extend Wekan with ease.

If you are an end-user and not a dev or a tester, create an issue to request new APIs.

All API calls in the documentation are made using curl. However, you are free to use Java / Python / PHP / Golang / Ruby / Swift / Objective-C / Rust / Scala / C# or any other programming languages.

Production Security Concerns

When calling a production Wekan server, ensure it is running via HTTPS and has a valid SSL Certificate. The login method requires you to post your username and password in plaintext, which is why we highly suggest only calling the REST login api over HTTPS. Also, few things to note:

• Only call via HTTPS
• Implement a timed authorization token expiration strategy
• Ensure the calling user only has permissions for what they are calling and no more

Login

Login with REST API

Request Body schema: application/jsonapplication/x-www-form-urlencodedapplication/json required

Login credentials

| username required |

string

Your username

| | password required |

string <password>

Your password

|

Responses

200

Successful authentication

400

Error in authentication

default

Error in authentication

post/users/login

/users/login

Request samples

• Payload

Content type application/jsonapplication/x-www-form-urlencodedapplication/json

Copy

`{

"username": "string",

"password": "pa$$word"

}`

Register with REST API

Notes:

• You will need to provide the token for any of the authenticated methods.

Request Body schema: application/x-www-form-urlencoded required

| username required |

string

Your username

| | password required |

string <password>

Your password

| | email required |

string

Your email

|

Responses

200

Successful registration

400

Error in registration

default

Error in registration

post/users/register

/users/register