Skip to content
SENS Platform Docs

Query global audit events as a platform administrator.

GET
/v1/audit-logs
curl --request GET \
  --url 'https://api.dev.iot-sens.schlossers.at/v1/audit-logs?eventType=security_event&limit=25' \
  --header 'Authorization: Bearer <token>'

Returns 25 metadata events at a time without an exact total. The first page fixes to as the upper investigation anchor. Continuations must reuse that anchor and every filter; refresh without a cursor creates a new anchor.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
string format: date-time

Both time bounds are required together and limited to 31 days.

to
string format: date-time

Fixed upper investigation anchor; continuations must reuse it.

eventType
string
Allowed values: security_event entity_change api_request
action
string
<= 128 characters
actorId
string
<= 128 characters
entityType
string
<= 128 characters
entityId
string
<= 128 characters
correlationId
string
<= 128 characters
method
string
<= 16 characters
route
string
<= 256 characters
statusCode
integer
>= 100 <= 599
cursor
string
<= 512 characters

Opaque continuation token; reuse the original filters and scope.

limit
integer
default: 25 >= 1 <= 100

Number of timeline records to return; defaults to 25, accepts 1 through 100, and is bound into continuation cursors.

Responses

Section titled “Responses”

200

Section titled “200”

Reverse-chronological audit event page.

Media typeapplication/json
object
items
required
Array<object>
object
auditLogId
required
string format: uuid
eventType
required
string
Allowed values: security_event entity_change api_request
tenantId
required
One of:
string format: uuid
actorType
required
string
Allowed values: anonymous user service
actorId
required
string
sessionId
required
One of:
string
action
required
string
entityType
required
string
entityId
required
One of:
string
correlationId
required
One of:
string
occurredAt
required
string format: date-time
httpMethod
required
One of:
string
httpRoute
required
One of:
string
httpStatusCode
required
One of:
integer
>= 100 <= 599
requestStartedAt
required
One of:
string format: date-time
requestCompletedAt
required
One of:
string format: date-time
durationMs
required
One of:
integer
outcome
required
string
Allowed values: success client_error server_error incomplete
metadata
required
object
<= 50 properties
key
additional properties
One of:
string
nextCursor
string
Example
{
  "items": [
    {
      "eventType": "security_event",
      "actorType": "anonymous",
      "outcome": "success"
    }
  ]
}

default

Section titled “default”

A safe platform error response.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED AUTHENTICATION_FAILED AUTHORIZATION_FAILED RESOURCE_NOT_FOUND CONFLICT DEPENDENCY_FAILURE FLOW_FAILURE RATE_LIMITED INTERNAL_ERROR
category
required
string
Allowed values: validation authentication authorization not_found conflict dependency_failure flow_failure rate_limit internal
message
required

Safe client-facing diagnostic message.

string
correlationId
required

Correlation ID for operational investigation.

string
>= 1 characters
details

Safe bounded diagnostic details.

object
key
additional properties
One of:
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED",
    "category": "validation"
  }
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store