API Docs

13 endpoint(s)

Method Path Auth Description Format CORS / Cache
GET / public Homepage with environment info html - · - Open
POST /api/logs public Create a log entry for a project
Params (5)
Headers
X-Private-Key

Project private key (required)

Body
reference_id

Reference ID (optional, UUID will be generated if empty)

group

Group name (optional, default: empty string)

event

Event type (required)

payload

Payload data as JSON object (required)

json api · -
GET /api/projects/(\d+)/logs roles: ROLE_USER Search logs for a project
Params (8)
Query
reference_id

Filter by reference ID (optional)

group

Filter by group (optional)

event

Filter by event type (optional)

payload_query

Search in payload JSON (optional)

page

Page number (default: 1)

per_page

Items per page (default: 20)

sort_by

Sort field: created_at, event, group, reference_id (default: created_at)

sort_dir

Sort direction: asc, desc (default: desc)

json api · -
DELETE /api/projects/(\d+)/logs roles: ROLE_USER Delete all logs for a project. Cannot delete logs for projects with is_easy_remove=false. json api · -
POST /api/projects/(\d+)/logs/([^/]+)/comment roles: ROLE_USER Add a comment to a log
Params (1)
Body
comment

Comment text (required)

json api · -
POST /api/projects/(\d+)/logs/([^/]+)/hide roles: ROLE_USER Hide a log from the listing json api · -
GET /api/projects roles: ROLE_USER Get all projects for the current user json api · -
GET /api/projects/(\d+) roles: ROLE_USER Get a single project by ID json api · -
POST /api/projects roles: ROLE_USER Create a new project
Params (1)
Body
name

Project name (required)

json api · -
PUT /api/projects/(\d+) roles: ROLE_USER Update a project
Params (1)
Body
name

Project name (required)

json api · -
POST /api/projects/(\d+)/rotate_token roles: ROLE_USER Rotate private key for a project json api · -
POST /api/users/register public Register a new user
Params (2)
Body
email

Valid email address (required)

password

Password, min 8 characters (required)

json api · -
POST /api/security/login public Authenticate a user
Params (2)
Body
email

User email (required)

password

User password (required)

json api · -