mirror of
https://github.com/plankanban/planka.git
synced 2026-02-05 00:39:58 +03:00
[Feature]: API Key support #604
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @JustSamuel on GitHub (Nov 15, 2024).
Is this a feature for the backend or frontend?
Backend
What would you like?
Add API keys to PLANKA. These API keys should be an alternative method to username password authentication. Most suitable for service accounts.
The following features would be nice
An overview of accounts with an API key for admins and management.
Why is this needed?
Currently, it is only possible to programmatically authenticate using a username and password. (Or an OIDC hack-ish method which allows for an API key)
This makes it more involved to create add-on software.
Currently, I have a project which enables emailing to a planka board. However, to get an API key I added a long-lived session token in the database manually, by signing it myself.
This is quite involved and will most likely mean that others are unable to use the service.
Other information
No response
@JustSamuel commented on GitHub (Nov 15, 2024):
@meltyshev I would be willing to work on this myself, but with the possibility of v2 arriving, I am unsure how useful this would be at this moment.
@meltyshev commented on GitHub (Nov 16, 2024):
Hi! This would be very useful, and I appreciate your willingness to implement it! You're right that waiting for version 2 might be better, as it will make migrating the current changes easier. On the other hand, implementing it now wouldn’t be a significant problem either.
@madduck commented on GitHub (Dec 1, 2024):
Yes please, offering my time to help and debug.
@smartynov commented on GitHub (Mar 6, 2025):
The API keys feature is definitely needed. I'm developing a Telegram bot for easy Planka integration (creating cards from chat messages) and have encountered a serious issue: my Planka installation is behind Cloudflare, and using the plankapy library results in a "Blocked by Browser Integrity Check" error due to Cloudflare's security filters (default settings).
Introducing API keys would make integrations both easier and more secure.
@kstan79 commented on GitHub (Jul 8, 2025):
+1
@JustSamuel commented on GitHub (Jul 8, 2025):
@madduck @smartynov @kstan79 (and others interested) I am planning to work fix this issue in this and the coming months. (Note I am not affiliated with Planka, just a OS developer.)
@rob-khan commented on GitHub (Oct 31, 2025):
Hey! Just wanted to add my voice here - we really need API key support.
We're trying to integrate Planka with AI tools like Claude Code to automate our task management, but the
username/password authentication makes it really difficult.
What we're hoping to do:
The main issue with username/password auth is that it's just not secure to store credentials in automation tools,
plus there's no way to limit what the API can access. Also makes things complicated when using SSO.
I know other tools like Trello and Linear have had this for years, so it would be great to see Planka catch up
here. The use cases for AI integrations are growing fast.
Saw that @JustSamuel is working on this - thank you! Happy to help test when it's ready.
@JustSamuel commented on GitHub (Oct 31, 2025):
I got around to implementing a first version of the required client code, could you please give it a spin?
@kstan79 @rob-khan @smartynov @madduck
https://github.com/plankanban/planka/pull/1254
@rob-khan commented on GitHub (Nov 5, 2025):
Thanks a lot for the quick update, @JustSamuel — that’s great news!
I’ll forward this to the person responsible for setting up our test environment so they can run the initial tests. Once it’s ready, I’ll also test it myself and share feedback.
Really appreciate your work on this — looking forward to seeing how it performs!