Audit Log

• Base URL: https://audit-logs.sls.epilot.io
• API Docs: https://docs.epilot.io/api/audit-logs

Service for managing and retrieving auditing logs in the scope of an organization

Quick Start

# List available operations
epilot audit-logs

# Call an operation
epilot audit-logs getLogs

Common Flags

Flag	Description
-p key=value	Set a named parameter
-d '{...}'	Request body JSON
-H 'Key: Value'	Custom header
-t, --token <token>	Bearer token for authentication
--profile <name>	Use a named profile
-s, --server <url>	Override server base URL
-i, --include	Include response headers in output
--json	Output raw JSON (no formatting)
-v, --verbose	Verbose output (show request details)
--jsonata <expr>	JSONata expression to transform response
--definition <file>	Override OpenAPI spec file/URL
--guided	Prompt for all parameters interactively
--no-interactive	Disable interactive prompts

Operations

Events

• getLogs — Retrieve Audit Log events. Optionally, you can filter them by organization.

Audit Log

• getLogById — Retrieve Audit Log events

getLogs

Retrieve Audit Log events. Optionally, you can filter them by organization.

POST /v1/logs

Request Body

Sample Call

epilot audit-logs getLogs

With request body:

epilot audit-logs getLogs \
  -d '{
  "limit": 50,
  "page": 0,
  "timestamp": "2021-06-01T12:00:00Z",
  "service_name": "workflows",
  "event_name": "deleteWorkflow",
  "outcome": "success",
  "method": "POST",
  "user": {
    "email": "max.mustermann@mail.com",
    "user_id": 123456
  }
}'

Using stdin pipe:

cat body.json | epilot audit-logs getLogs

With JSONata filter:

epilot audit-logs getLogs --jsonata 'logs'

Sample Response

{
  "logs": [
    {
      "id": "2843c005-c5b0-4df2-94ee-1ca2ddd998ac",
      "org_id": 123456,
      "service_name": "workflows",
      "event_name": "deleteWorkflow",
      "status_code": 200,
      "timestamp": "2021-06-01T12:00:00Z",
      "caller": {
        "user_email": "max.mustermann@mail.com",
        "user_id": 123456,
        "trigger_type": "user"
      },
      "http": {
        "method": "GET",
        "ip": null,
        "headers": {
          "Authorization": "Bearer token"
        },
        "query": {
          "limit": 50,
          "page": 0
        },
        "pathParams": {
          "eventId": "2843c005-c5b0-4df2-94ee-1ca2ddd998ac"
        },
        "path": "/v1/logs",
        "domainName": "audit-logs.sls.epilot.io"
      },
      "detail": "{\"workflow_id\": \"123456\"}",
      "activity": "Workflow with ID 123456 was deleted",
      "source_url": "string"
    }
  ],
  "total": 1
}

---

getLogById

Retrieve Audit Log events

GET /v1/logs/{logId}

Parameters

Name	In	Type	Required	Description
logId	path	string	Yes	ID of the log event

Sample Call

epilot audit-logs getLogById \
  -p logId=2843c005-c5b0-4df2-94ee-1ca2ddd998ac

Using positional args for path parameters:

epilot audit-logs getLogById 2843c005-c5b0-4df2-94ee-1ca2ddd998ac

With JSONata filter:

epilot audit-logs getLogById -p logId=2843c005-c5b0-4df2-94ee-1ca2ddd998ac --jsonata 'log'

Sample Response

{
  "log": {
    "id": "2843c005-c5b0-4df2-94ee-1ca2ddd998ac",
    "org_id": 123456,
    "service_name": "workflows",
    "event_name": "deleteWorkflow",
    "status_code": 200,
    "timestamp": "2021-06-01T12:00:00Z",
    "caller": {
      "user_email": "max.mustermann@mail.com",
      "user_id": 123456,
      "trigger_type": "user"
    },
    "http": {
      "method": "GET",
      "ip": null,
      "headers": {
        "Authorization": "Bearer token"
      },
      "query": {
        "limit": 50,
        "page": 0
      },
      "pathParams": {
        "eventId": "2843c005-c5b0-4df2-94ee-1ca2ddd998ac"
      },
      "path": "/v1/logs",
      "domainName": "audit-logs.sls.epilot.io"
    },
    "detail": "{\"workflow_id\": \"123456\"}",
    "activity": "Workflow with ID 123456 was deleted",
    "source_url": "string"
  }
}

---