github-mirrors/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-08-15 16:53:57 -04:00
Code Issues Projects Releases Packages Wiki Activity
Page: REST API
Pages
ADFS AWS Accounts Lockout Adding new Snap settings to code Adding users Allow private boards only Android Apache Archive and Delete Asana AsyncAwait Azure B2C Backup Browser compatibility matrix Burndown and Velocity Chart CAS CSV Caddy Webserver Config Calendar Change Language Chromebook Cloud Foundry CloudFlare Cloudron Converting Meteor Stylus to CSS Cover Cron Custom CSS themes Custom Fields Custom Logo Customize Translations Dark Mode Day of week start Debian Debugging Deep Dive Into WeKan Delete Board Design Principles Developer Documentation Directory Structure Disable Password Login Docker Dome Drag Drop Due Date Emoji Excel and VBA Export Docker Mongo Data Export from Wekan Sandstorm grain .zip file FAQ Features Forgot Password FreeBSD Friend From Previous Export Gantt Google Cloud Google login Hall of Shame Helm Heroku Home IFTTT IRC FAQ If board does not open and keeps loading Impersonate user Install Wekan Docker for testing Install Wekan Docker in production Install Wekan Docker on SUSE Linux Enterprise Server 12 SP1 Install Wekan from source on Windows Install Windows Install and Update Install from source without root Install latest Wekan release on Uberspace Install source without sudo on Linux Integrations Java Jira Keycloak LDAP AD Simple Auth LDAP LaTeX Leo Let's Encrypt and Google Auth Linked Cards Local self signed TLS Logs Mac Mermaid Diagram Metal Meteor bundle Meteor Metrics Migrating from Trello Migrating from old Wekan manually Monkey Proof Software Move Docker containers to other computer Multiline Multitenancy NOT related to Wekan New card with Python3 and REST API Nextcloud Nginx Webserver Config Numbered text OAuth2 OVH Offline OpenShift OpenSuse OpenVZ Oracle Identity Cloud Oracle OIM Outgoing Webhook to Discord PWA Password Hashing PikaPods Planning Poker Platforms PostgreSQL Press Python Qnap NAS REST API Boards REST API Cards REST API Checklists REST API Code REST API Custom Fields REST API Integrations REST API Lists REST API Role REST API Swimlanes REST API User REST API Rancher Rancher Active Proxy Wekan MongoDB Docker Raspberry Pi Rclone Receiving Webhooks Repair Docker Repair MongoDB Requirements Roadmap RocketChat SAML Sandstorm Scaling Scalingo Secure Boot Security Disclosure Settings SmartOS Snap Source Subtasks Swimlanes Sync Team Templates Test Edge Time Tracking Timezone Touch Screen support Traefik and self signed SSL certs Translations Troubleshooting Mail UCS Ubuntu Core Upgrade Vagrant Vultr WSL Wait Spinners WeKan Multiverse Roadmap WebHook And CA Webhook data Wekan Markdown Wekan Sandstorm cards to CSV using Python Wekan vs Sandstorm Wekan vs Trello vs Restyaboard Windows ZenKit Zitadel autologin ppc s390x virtual appliance
29 REST API
Lauri Ojansivu edited this page 2023-01-16 00:41:57 +02:00
Table of Contents

REST API is not complete yet, please add missing functionality with pull requests to devel branch.

If you are in a hurry, you can use these to have more functionality:

For workflows see If-this-then-that issue than mentions Huginn, Flogo etc.

Wekan REST API

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

Summary

Authentication

HTTP Method Url Short Description
POST /users/login Authenticate with the REST API.

Users

HTTP Method Url Short Description
POST /users/register Register a new user.
POST /api/users Create a new user.
PUT /api/users/:id Disable an existing user.
PUT /api/users/:id Enable an existing user.
PUT /api/users/:id Admin takes the ownership.
DELETE /api/users/:id Delete an existing user. (Warning)
GET /api/users/:id Gets a user's information.
GET /api/users All of the users.
GET /api/user Gets a logged-in user.

Cards

HTTP Method Url Short Description
POST /api/boards/:boardId/lists/:listId/cards Add a card to a list, board, and swimlane.
PUT /api/boards/:boardId/lists/:fromListId/cards/:cardId Update a card.
DELETE /api/boards/:boardId/lists/:listId/cards/:cardId Delete a card.

Login

URL Requires Auth HTTP Method
/users/login no POST

Payload

Authentication with username

Argument Example Required Description
username myusername Required Your username
password my$up3erP@ssw0rd Required Your password

Authentication with email

Argument Example Required Description
email my@email.com Required Your email
password my$up3erP@ssw0rd Required Your password
  • Notes:
  • You will need to provide the token for any of the authenticated methods.

Example Call - As Form Data

DOES NOT WORK ! Please use As JSON example below ! https://github.com/wekan/wekan/issues/4807

curl http://localhost:3000/users/login \
     -d "username=myusername&password=mypassword"

curl http://localhost:3000/users/login \
     -d "email=my@email.com&password=mypassword"

Example Call - As JSON

THIS WORKS !! Alternatively, look at api.py example at https://github.com/wekan/wekan

NOTE: Username and password is case sensitive. So type BIG and small letters correctly.

curl -H "Content-type:application/json" \
      http://localhost:3000/users/login \
      -d '{ "username": "myusername", "password": "mypassword" }'

curl -H "Content-type:application/json" \
      http://localhost:3000/users/login \
      -d '{ "email": "my@email.com", "password": "mypassword" }'

Result

{
  "id": "user id",
  "token": "string",
  "tokenExpires": "ISO encoded date string"
}

Result example

{
  "id": "XQMZgynx9M79qTtQc",
  "token": "ExMp2s9ML1JNp_l11sIfINPT3wykZ1SsVwg-cnxKdc8",
  "tokenExpires": "2017-12-15T00:47:26.303Z"
}

Wekan

General

Fake: Not WeKan kanban

Security

Scaling

Migrating

Support priorities for new features and bugfixes

  1. Commercial Support
  2. Community Support
  3. Debugging

Backup

Repair

Themes

Markdown Syntax

Login Auth

Metrics, Logs, Stats

Integrations

Time

Features

Email

Required Settings

Download

Webservers

REST API Docs

REST API issue

REST API client code

Webhooks

Case Studies

Development

Issues

Wekan - OpenSource Kanban