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 ressource 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 | |||
| j | GET: list zettel AS JSON | GET: retrieve zettel AS JSON | JSON |
| POST: create new zettel | PUT: update a zettel | ||
| DELETE: delete the zettel | |||
| MOVE: rename the zettel | |||
| l | GET: list references | Links | |
| m | GET: retrieve metadata | Metadata | |
| o | GET: list zettel order | Order | |
| p | GET: retrieve parsed zettel | Parsed | |
| r | GET: list roles | Roles | |
| t | GET: list tags | Tags | |
| u | GET unlinked references | Unlinked | |
| v | POST: encode inlines | GET: retrieve evaluated zettel | Evaluated |
| x | POST: execute command | GET: list zettel context | Context |
| z | GET: list zettel | GET: retrieve zettel | Zettel |
| POST: create new zettel | PUT: update a zettel | ||
| DELETE: delete zettel | |||
| MOVE: rename zettel |
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.