Endpoints used by the API
All API endpoints conform to the pattern [PREFIX]LETTER[/ZETTEL-ID], where:
- PREFIX
is the URL prefix (default: “/”), configured via the url-prefix startup configuration,
- LETTER
is a single letter that specifies the resource type,
- ZETTEL-ID
is an optional 14 digits string that uniquely identify a zettel.
The following letters are currently in use:
Letter | Without zettel identifier | With zettel identifier | Mnemonic |
a | POST: client authentication | Authenticate | |
PUT: renew access token | |||
x | GET: retrieve administrative data | Execute | |
POST: execute command | |||
z | GET: list zettel/query zettel | GET: retrieve zettel | Zettel |
POST: create new zettel | PUT: update zettel | ||
DELETE: delete zettel | |||
MOVE: rename zettel1 |
The full URL will contain either the “http” oder “https” scheme, a host name, and an optional port number.
The API examples will assume the “http” schema, the local host “127.0.0.1”, the default port “23123”, and the default empty PREFIX “/”. Therefore, all URLs in the API documentation will begin with “http://127.0.0.1:23123/”.
- Renaming a zettel is deprecated and will be removed in version 0.19 or later. ↩︎
Incoming
- Layout of a Zettel
- API
- API: Determine a tag zettel
- API: Determine a role zettel
- API: Retrieve metadata of an existing zettel
- API: Retrieve evaluated metadata and content of an existing zettel in various encodings
- API: Retrieve parsed metadata and content of an existing zettel in various encodings
- API: Check for authentication
- API: Refresh internal data