API docs by Redocly

SmartTouch Audit Log API (1.0.0)

Download OpenAPI specification:

URL: https://docs.smarttouch.io License: Proprietary

Query the immutable audit log for remote access events on the SmartTouch Cloud Platform.

Every remote access session open, close, and expiry is recorded as an audit entry. Entries include the user identity, device, protocol, source IP, timestamp, and a distributed trace ID for correlation with logs and traces.

Access control

Reading the audit log requires either the administrator role or the audit:read permission granted by an Administrator.

Immutability

Audit entries cannot be created, modified, or deleted through the API. The audit log is append-only and tamper-evident.

Retention

Entries are retained for 90 days by default. Administrators can configure longer retention in platform settings.

Authentication

All endpoints require a bearer token obtained via stctl auth token.

Base URL

https://api.<your-platform-domain>/v1

Related APIs

  • Session API — open and close sessions that generate audit events
  • Device API — filter audit events by device

Audit Log

Query remote access audit events (read-only)

List audit log entries

Returns audit log entries for remote access events in reverse chronological order (most recent first).

Use query parameters to narrow results by device, user, event type, or time range. All filter parameters are optional and combinable.

Rate limit: 60 requests per minute.

Authorizations:
bearerAuth
query Parameters
device_id
string
Example: device_id=sensor-001

Filter by device ID

user
string <email>
Example: user=alice@example.com

Filter by user email address

event
string
Enum: "session.opened" "session.closed" "session.expired"

Filter by event type

protocol
string
Enum: "shell" "diagnostics" "file-transfer"

Filter by session protocol

since
string <date-time>
Example: since=2026-06-08T00:00:00Z

Return entries with timestamps after this ISO 8601 value (inclusive)

until
string <date-time>
Example: until=2026-06-09T00:00:00Z

Return entries with timestamps before this ISO 8601 value (exclusive)

session_id
string
Example: session_id=sess-9c4d2e

Filter by session ID to retrieve all events for a single session

page
integer >= 1
Default: 1
per_page
integer [ 1 .. 500 ]
Default: 100

Responses

Response samples

Content type
application/json
Example
{
  • "status": 200,
  • "data": [
    ],
  • "meta": {
    }
}

Get an audit log entry

Returns a single audit log entry by its ID.

Authorizations:
bearerAuth
path Parameters
entryId
required
string
Example: audit-001

Unique audit log entry ID

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    }
}