EvoHub Docs Sign in

EvoTrail API › Audit trail

Get one audit event

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

GET/api/v1/evotrail/audit/{id}

One event with before, after and metadata. An event of a product the key may not read answers 404, as if it did not exist.

Permission (API-key scope): evotrail:audit:read. The event's product also needs its *:audit:read.

Authorization

Any one of:

Parameters

Path parameters

  • id string required
    The id named by the path: an audit event's id (a UUID) under /audit, a status page's or a docs or changelog site's id under /metrics.
    Max length: 200

Responses

200

The event.

Content type: application/json

Type: object

  • data AuditEvent required
    Show AuditEvent properties
    • id string (uuid) required
    • event_id string required
      The producing product's own id for the event.
    • source string required
      The service that reported it.
    • product Product required
      One of: organization oncall uptime status docs changelog board retro support catalog evotrail
    • team_id string | null
      The team the resource belongs to.
    • actor object required
      • type string
        One of: user api_key agent system evohub_staff
      • id string | null
      • name string | null
      • teams array of string | null
    • action string required
      <resource>.<verb>, for example alert.acknowledged or member.role_changed.
    • class string required
      audit is a change to configuration or access (kept 365 days); activity is day-to-day work (kept 90 days).
      One of: audit activity
    • resource object required
      • type string | null
      • id string | null
      • name string | null
    • request_id string | null
    • ip string | null
      Kept 90 days.
    • user_agent string | null
      Kept 90 days.
    • occurred_at string (date-time) required
    • has_details boolean required
      Whether before, after or metadata exist; read the single event to get them.
    • before any
      The resource before the change (single-event read only). Secrets are masked by the producer.
    • after any
      The resource after the change (single-event read only).
    • metadata any
      Anything else the product recorded (single-event read only).
  • success boolean required
    Value: true

401

No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.
  • success boolean
    Value: false

403

The key lacks the EvoTrail scope, or may read none of the products asked for (FORBIDDEN).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.
  • success boolean
    Value: false

404

No such event, or one the key may not read (NOT_FOUND).

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.
  • success boolean
    Value: false

429

Too many requests (RATE_LIMITED). Wait Retry-After seconds.

Headers

  • Retry-After integer
    Seconds to wait.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.
  • success boolean
    Value: false

500

Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.

Content type: application/json

Type: Error

  • error object required
    • code string required
      Machine-readable code. Branch on this.
    • message string required
      Human-readable explanation.
    • request_id string
      This request's id, also in X-Request-ID.
  • success boolean
    Value: false

Example request

curl -X GET 'https://evohub.io/api/v1/evotrail/audit/string' \
  -H 'Authorization: Bearer <TOKEN>'

Last updated