What the API covers

Nearly everything you can do in the browser, a script can do through the API, because the browser uses the same requests. Here is what there is, by area, so you know where to look in the full reference at /api/docs on your server.

• Spaces: list, create, read, rename, archive, delete, choose which exports are allowed, and import a wiki pack.

• Pages: the page tree, create, read, update, move (also to another space), copy, full width, delete, restore from the trash, and delete permanently.

• Drafts: start a new page as a draft, publish it, or throw it away.

• Versions: a page’s history, any one version, and restoring one.

• Attachments: upload, list, download and delete a page’s files.

• Comments: list, add, edit, delete, resolve and reopen.

• Labels: the labels in use, the pages with a label, and adding and removing a page’s labels.

• Search: full-text search, everywhere or in one space.

• Exports: a page as Markdown, HTML or PDF; a space as a website or a wiki pack.

• Permissions: who can view, edit and administer a space, and restrictions on a page.

• Groups and people: groups and their members, and the list of accounts.

• Watching and notifications: watch a page or a space, read your notifications and mark them read.

• Templates: list, create, rename and delete.

• Webhooks: list, add and delete a space’s webhooks. See Webhooks.

• Live content: what a live content block on a page shows, worked out for whoever asks.

• Your account: profile, picture, email, password, sessions, two-factor, recovery codes and API tokens.

• Administration: settings, users, spaces, invites, security, roles, backups, branding, the audit log and the dashboard. Each needs the right for it, the same as in the browser.

• Health: /api/health says whether Tesria is running, without signing in; with a token or signed in, it also names the version.