Documentation · API reference
PUT/api/v1/sites/{site}/hard

Save what hard mode keeps and for how long

Save what hard mode keeps and for how long. Does not turn it on.

Parameters

sitein the address
neededA site's id or name

What to send

any

The answer

Status 200

HardView A site's mode and what turning hard mode on still needs (MO-02).

banner
integer or nullThe banner version being shown, if one is.
checklist
list of objectneeded
compare
list of ModeLineneededWhat each mode does, line by line (MO-07).
holds
list of HeldneededRows hard mode holds for the site, table by table.
mode
stringneeded`easy` or `hard`.
policy_text
stringneededThe paragraph for the site's privacy policy.
reading
stringneededThe reading of the law the site is set up for: `strict` or `cnil`.
ready
booleanneededEvery step but the last is done: it can be turned on.
settings
objectneeded
site
stringneeded

Asking

With your token from Settings
curl -X PUT https://tidekeeper.eu/api/v1/sites/example.org/hard \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'
With your token from Settings
const answer = await fetch("https://tidekeeper.eu/api/v1/sites/example.org/hard", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
}).then((r) => r.json());