Access

Audit log

Every change made through the panel or the API, and every sign-in, is recorded in Settings → Audit log, for admins.

What's recorded

Each request that changes something (anything but GET, HEAD and OPTIONS), once it's answered:

  • who: the user, as "Name " then (kept when the user is removed), and how: through the panel (session), an API token (so the CLI and CI), or a webhook from GitHub or GitLab;
  • what: the route (/api/apps/{id}/deploy) and the path asked, said in words ("Deployed the app"; a route without words is said as its method and route);
  • on what: the app, server, database, domain, backup, token, alert channel or git account it's about, and its name, so a delete still says what it deleted. A deployment's, deploy's or build's app is named;
  • how it went: the answer's status, so refused requests (403, 409, 422) show too;
  • from where: the client's address.

Bodies aren't kept: they hold passwords, tokens and variables.

A sign-in is recorded when its session starts (password, code, passkey, a new account or an accepted invite), and a wrong password when it's turned away, with the email tried.

Not recorded: reads; requests turned away for want of a user (401); the intermediate steps of a sign-in; webhooks that did nothing (pings, pushes to other branches).

Entries are kept 365 days. Recording never holds up a request, so an entry can occasionally be missing if writing it failed.

Reading it

Settings → Audit log; an app's Settings tab links to its own entries.

GET /api/audit (admins): newest first, 100 at a time (limit up to 500), older pages with before (the last id of the page before); filtered by user_id, target_id (an app's entries), q (in the action, who, or the target's name) and failed (only 4xx and 5xx).