Security
The Security tab manages the administrator password, session timeout, API tokens, and two-factor authentication, and provides an audit trail of API activity on the system.
Overview
The tab has these sections:
- Change Password — changes the password of the signed-in administrator. Enter the current password, then the new password twice.
- Session Timeout — Auto-logout after inactivity signs users out after a period with no activity: 30 minutes, 1 hour (the default), 2 hours, 4 hours, or 8 hours.
- API Tokens — creates long-lived bearer tokens for automation scripts or CI/CD pipelines that call the API without an interactive session.
- Two-Factor Authentication — protects the account with a TOTP authenticator app, such as Google Authenticator. Once enabled, a 6-digit code is required at every login.
- API Access Log — shows the API requests the backend has received: who made each one, what they did, and whether it succeeded.
API Access Log
The API Access Log is a paginated table of API calls made to the console backend, 50 rows per page. Use it to investigate configuration changes, detect unexpected access, and confirm that automation is behaving as intended.
| Column | Description |
|---|---|
| Timestamp | The date and time the backend received the request, shown in your browser's local time. |
| Source IP | The source IP of the caller. In Kubernetes deployments behind a load balancer or ingress, this may be the cluster-internal IP rather than the originating client IP. |
| Method | The HTTP method of the request, such as GET, POST, PUT, or DELETE. |
| Route | The request path, for example /api/settings/clusters. Query parameters are not included. |
| Status | The HTTP response code. 200 or 201 indicates success, 401 or 403 an authentication or authorization failure, and 500 a backend error. |
| User | The authenticated user for the request. Unauthenticated requests show as anonymous. |
| Auth | How the request authenticated: session, token (hover it to see the token name), or anonymous. |
| ms | The time in milliseconds the backend took to process the request. |
Not every request is logged. Health checks, agent machine-to-machine calls, API documentation paths, and the log's own endpoint are skipped. The rest, including read-only polling, are recorded.
The filter box (Filter by IP, route, user, method…) searches only the 50 rows on the current page, not the whole log.
Export CSV
Export CSV downloads the audit log as a comma-separated values file. Use it for compliance reporting or offline analysis.
The audit log retains up to 1,000,000 entries. When the limit is reached, the oldest records are trimmed automatically. Export CSV contains only the most recent 10,000 entries, so on a busy system the export does not hold the full log.
Clear
Clear permanently deletes all API audit log entries. A confirmation dialog appears first. There is no recycle bin or recovery path. Because Export CSV holds only the most recent 10,000 entries, exporting first does not keep a copy of a larger log.
API Tokens
API tokens are long-lived bearer tokens for programmatic access to the console API. They are an alternative to session-cookie authentication for non-interactive callers.
- Token Name — a human-readable label for the token. Use names that identify the caller, such as
ci-pipeline. - Expiry Date — optional. After this date the token stops working. Leave it blank for a token that does not expire.
- Scope — every token created here has full access to the API, the same as a signed-in administrator: it can read and change settings and start jobs. The token list shows this scope as API.
- Create Token — generates a token with the given name. The full token value is shown once, in the creation dialog. Copy it immediately, because it cannot be retrieved after you close the dialog.
- Revoke — permanently invalidates a token, after you confirm. Any caller that uses it receives a
401response from then on. Revoke tokens that are no longer needed or that may have been compromised.
Every token has full API access, so treat it like an administrator password: give each caller its own token, and revoke any token that may have leaked. If a token value is lost, revoke the token and create a new one.
Workflows
Investigate a suspicious configuration change
- Open the Security tab and go to the API Access Log section.
- Filter by the path of the endpoint that was called, for example
/api/settings. The filter applies to the current page only, so page through the log as needed. - Check the Timestamp, User, and Source IP columns to identify who made the change and when.
- If the IP address or username is unexpected, revoke any API tokens that may have been compromised.
Export the audit log for compliance review
- Click Export CSV. The file holds the most recent 10,000 entries.
- Open the downloaded file in a spreadsheet application or import it into your compliance tool.
Clear the audit log
- Optionally, click Export CSV and confirm that the download is complete. The export holds only the most recent 10,000 entries.
- Click Clear.
- Confirm the deletion in the dialog.
Tips
- In Kubernetes, configure the ingress or load balancer to forward the
X-Forwarded-Forheader so that the recorded IP address is the true client IP rather than the cluster-internal hop.