Documentation · API reference
POST
/api/v1/sites/{site}/share/linksPost link
This page as Markdown, or in an AI chatMore ways to read this page
# Post link
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-sites-site-share-links
`POST /api/v1/sites/{site}/share/links`
## Parameters
- `site` (in path, needed): The site's id or name
## What to send
`ShareLinkCreate`
- `name` (string, needed)
- `password` (string or null)
## The answer
201, `ShareLinkView`
- `has_password` (boolean, needed)
- `id` (string, needed)
- `last_opened` (integer or null)
- `made` (integer, needed)
- `name` (string, needed): Who it is for, in the owner's words.
- `opened` (integer, needed)
- `url` (string, needed): The address that opens it.
## Asking
```sh
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/share/links \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "…"}'
```
Parameters
- sitein the address
- neededThe site's id or name
What to send
ShareLinkCreate
- name
- stringneeded
- password
- string or null
The answer
Status 201
ShareLinkView
- has_password
- booleanneeded
- id
- stringneeded
- last_opened
- integer or null
- made
- integerneeded
- name
- stringneededWho it is for, in the owner's words.
- opened
- integerneeded
- url
- stringneededThe address that opens it.
Asking
curl -X POST https://tidekeeper.eu/api/v1/sites/example.org/share/links \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name": "…"}'
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/share/links", { method: "POST", headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({"name": "…"}), }).then((r) => r.json());