Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Wekan REST Event Log API
version: v12.65
description: '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'
tags:
- name: Event Log
paths:
/api/admin/problems:
get:
operationId: get_admin_problems
summary: Get the Admin Panel / Problems status overview
description: 'What Admin Panel / Problems / Summary shows: every migration or
repair in progress, the detected problems (broken cards, lists missing their
swimlane, failing login-page checks), and for each event stream (`security`,
`speed`, `tests`, `cpu`, `database`, `integrity`) how many problems are newer
than its acknowledgment. The same overview `snap run wekan.problems` prints.
Only the global admin can call this.'
tags:
- Event Log
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type:
inProgress:
- kind: string
active: boolean
message: string
problems:
- id: string
severity: string
title: string
detail: string
count: number
newProblems:
- stream: string
count: number
streams:
- string
/api/admin/problems/{stream}:
get:
operationId: get_admin_problem_stream
summary: Get one page of an Admin Panel / Problems event stream
description: 'One page of a stream''s rows, newest first (the `api` usage
stream sorts by count): `security` (Security Report), `speed`, `tests`,
`cpu`, `database` (restarts, storage and disk-space findings, indexes
created), `integrity` and `api`. Each row is a SUMMARY that accumulates -
`count`, `firstAt`..`at`, `actors` - never a row per event. Only the global
admin can call this.'
tags:
- Event Log
parameters:
- name: stream
in: path
description: 'the stream name: security, speed, tests, cpu, database, integrity or api
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type:
stream: string
total: number
limit: number
skip: number
rows:
- object
/api/admin/problems/{stream}/acknowledge:
post:
operationId: acknowledge_admin_problem_stream
summary: Acknowledge the new problems of an event stream
description: 'Marks everything currently in the stream as seen, the way the
Admin Panel''s acknowledge button does, so `get_admin_problems` reports zero
new problems for it until the next one is recorded. Only the global admin
can call this.'
tags:
- Event Log
parameters:
- name: stream
in: path
description: 'the stream name: security, speed, tests, cpu, database or integrity
'
required: true
schema:
type: string
security:
- UserSecurity: []
responses:
'200':
description: 200 response
content:
application/json:
schema:
type: object
properties:
acknowledged:
type: string
components:
securitySchemes:
UserSecurity:
type: apiKey
in: header
name: Authorization