Kanera Health API
Check whether the public API process is alive before sending integration traffic.
Check whether the public API process is alive before sending integration traffic.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/kanera-app:kanera-app-health-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Kanera Public Health API
version: 1.0.0
description: 'Kanera''s public API lets you build integrations around the same workspace, board, card, separator, note, comment, attachment, activity, and external-link data that users manage in the app. ## Quickstart
1. In Kanera, open **Workspace Settings -> API** as a workspace admin or owner. 2. Create a workspace API key and copy the secret. It is shown once. 3. Send the key as a bearer token:
```bash
curl "$KANERA_PUBLIC_API_URL/api/v1/workspaces" \
-H "Authorization: Bearer kanera__..."
```
The OpenAPI document at `/openapi.json` is the source of truth for this reference, Scalar at `/docs`, Swagger UI at `/swagger`, and SDK generation. ## Base URL and Versioning
All REST endpoints are under `/api/v1` on the public API service. Signed media URLs and webhook event discovery live outside that prefix because they are operational helpers rather than workspace resources. ## Authentication
Use an API key in `Authorization: Bearer kanera__...` where `` is `live`, `stg`, `dev`, or `test`. Missing or invalid keys return `401`; valid keys without access to a resource return `403`. OAuth-capable agents can instead discover the authorization server from the MCP protected-resource metadata, complete authorization code + PKCE in the browser, and send the resulting short-lived `kanera_oauth_...` bearer token. Unattended workspace agents use a confidential service connection with the `client_credentials` grant. There are two kinds of key:
- **Workspace keys** (created by a workspace admin) are workspace-scoped: they can only access resources in the workspace where the key was created, with powers set by the key''s `read`/`write`/`admin` scope. - **Personal keys** (created by any user under Account settings) act as their owner across every organisation, workspace, and board the owner can access, respecting the owner''s current role at each scope; activity is attributed to the owner. Personal keys are identifiable by a `u` marker in the prefix: `kanera_u__...`. Interactive user OAuth grants used by MCP have the same identity-wide organisation reach as personal
keys. A workspace/service OAuth connection remains pinned to its workspace. Existing resource ids
automatically select their owning organisation, so neither a personal key nor MCP needs a new login,
grant, or token when moving between organisations. For a personal-key operation without an existing
target resource, such as creating a workspace or inspecting a chosen session context, send
`X-Kanera-Organisation-Id: `. ## Workspace Model
Kanera is intentionally workspace-first:
- Lists are shared by every board in a workspace. - Custom fields are shared by every board in a workspace. - Workspace membership grants workspace-level access. Cross-organisation guests instead receive explicit access to individual boards and are not workspace members. - External links map outside-system records to Kanera entities so sync jobs can be safely retried. Standalone boards use the same model without exposing a workspace shell: a workspace with
`kind="board"` owns exactly one board and its shared lists, fields, labels, automations, templates,
webhooks, keys, and guests. These hidden workspaces are omitted from `GET /workspaces`, but appear in
`GET /boards`; a workspace-scoped key created there can still open its pinned workspace. Creating
another board is rejected. Imports started from the Kanera app populate the
existing sole board instead of creating a second one. `GET /workspaces` therefore returns only workspaces the credential can access at workspace scope. It does not return the parent workspaces of boards shared with a cross-organisation guest. Use `GET /boards` for complete board discovery, including board-only guest access.'
servers:
- url: /api/v1
description: Public API v1
tags:
- name: Health
description: Check whether the public API process is alive before sending integration traffic.
paths:
/health:
get:
tags:
- Health
summary: Health check
operationId: getPublicApiHealth
responses:
'200':
description: Success.
content:
application/json:
schema:
$ref: '#/components/schemas/Health'
default:
$ref: '#/components/responses/ApiError'
description: Health check.
components:
responses:
ApiError:
description: An error response not otherwise listed for the operation.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Health:
type: object
required:
- ok
- service
properties:
ok:
type: boolean
service:
type: string
Error:
type: object
required:
- code
- message
properties:
code:
type: string
examples:
- VALIDATION
- UNAUTHORIZED
- FORBIDDEN
- NOT_FOUND
- CONFLICT
- RATE_LIMITED
- INTERNAL
message:
type: string
issues:
type: array
items:
type: object
additionalProperties: true
reason:
type: string
enum:
- token_expired
- no_token
- token_invalid
description: 'On 401 UNAUTHORIZED: why the bearer credential was rejected.'
additionalProperties: true
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: Kanera workspace API key
description: 'Use `Authorization: Bearer kanera_<env>_...`.'
KaneraOAuth:
type: oauth2
description: Short-lived user or workspace-service OAuth tokens.
flows:
authorizationCode:
authorizationUrl: /oauth/authorize
tokenUrl: /oauth/token
scopes:
kanera:read: Read accessible Kanera project data.
kanera:write: Create and update accessible Kanera content, including supported workspace administration where the authorizing user is an administrator.
clientCredentials:
tokenUrl: /oauth/token
scopes:
kanera:read: Read the service connection's workspace.
kanera:write: Create and update content in the service connection's workspace.
kanera:admin: Perform supported workspace-admin API operations.