Authentication

Last updated: May 29, 2026

The REST API requires at least xltrail v4.0.2

API Key

In xltrail, go to Settings > API Key to create and copy your API key.

There are two types of API keys: Personal API Key and Group API Key. The Group API Key can only be used for incoming webhooks (e.g., GitLab integration). For the REST API, use the Personal API Key.

Headers

All requests must include the following headers:

X-API-KEY: your_api_key
Accept: application/json
Content-Type: application/json

Base URL

The base URL is the URL of your xltrail instance + /api. For example, https://xltrail.yourcompany.com/api. Always prepend the base URL in front of the endpoints below.

Note: The API accepts both /repos and /repositories as path prefixes (e.g., /api/repos/my-repo/contents and /api/repositories/my-repo/contents are equivalent).