Fireblocks Audit Logs API

openapi: 3.2.0
info:
  title: Fireblocks Audit Logs API
  description: 'Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain.


    - Visit our website for more information: Fireblocks Website

    - Visit our developer docs: Fireblocks DevPortal'
  version: 1.6.2
  contact:
    email: developers@fireblocks.com
servers:
- url: https://api.fireblocks.io/v1
  description: Fireblocks Production Environment Base URL
- url: https://sandbox-api.fireblocks.io/v1
  description: Fireblocks Sandbox Environment Base URL
tags:
- name: Audit Logs
paths:
  /management/audit_logs:
    get:
      summary: Get audit logs
      description: 'Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination.


        Filters within the same field are combined as OR (e.g. category=Administration&category=Security returns events in either category). Filters across different fields are combined as AND.


        **Deprecated parameters:** `timePeriod` and `cursor` remain functional for backward compatibility but new integrations should use `startTime`/`endTime` and `pageCursor` instead.


        Endpoint Permission: Admin, Non-Signing Admin, Auditor, Security Admin, Security Auditor.'
      tags:
      - Audit Logs
      x-rate-limit-category: query
      parameters:
      - in: query
        name: startTime
        required: false
        description: Start of date range as epoch time in milliseconds. Takes precedence over timePeriod when provided. Must be no more than 1 year before the current time.
        schema:
          type: integer
      - in: query
        name: endTime
        required: false
        description: End of date range as epoch time in milliseconds. Must be after startTime. Defaults to now when omitted.
        schema:
          type: integer
      - in: query
        name: timePeriod
        required: false
        deprecated: true
        description: Deprecated. Use startTime/endTime instead. Ignored when startTime is provided. Defaults to DAY when neither timePeriod nor startTime is supplied.
        schema:
          type: string
          enum:
          - DAY
          - WEEK
      - in: query
        name: category
        required: false
        description: Filter by event category. Repeat the parameter for multiple values (OR logic within field).
        schema:
          type: array
          items:
            type: string
      - in: query
        name: subject
        required: false
        description: Filter by event subject. Repeat the parameter for multiple values.
        schema:
          type: array
          items:
            type: string
      - in: query
        name: event
        required: false
        description: Filter by event type. Repeat the parameter for multiple values.
        schema:
          type: array
          items:
            type: string
      - in: query
        name: user
        required: false
        description: Filter by user name. Repeat the parameter for multiple values.
        schema:
          type: array
          items:
            type: string
      - in: query
        name: userId
        required: false
        description: Filter by user ID. Repeat the parameter for multiple values.
        schema:
          type: array
          items:
            type: string
      - in: query
        name: order
        required: false
        description: Sort direction. Defaults to DESC.
        schema:
          type: string
          enum:
          - ASC
          - DESC
          default: DESC
      - in: query
        name: pageSize
        required: false
        description: Number of results per page. Maximum 500. Defaults to 200.
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 200
      - in: query
        name: pageCursor
        required: false
        description: Cursor returned from the previous response to fetch the next page.
        schema:
          type: string
      - in: query
        name: cursor
        required: false
        deprecated: true
        description: Deprecated. Use pageCursor instead.
        schema:
          type: string
      responses:
        '200':
          description: Audit log events matching the requested filters and date range
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditLogsResponse'
        '400':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Error'
      operationId: getAuditLogs
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<GetAuditLogsResponse>> = fireblocks.auditLogs.getAuditLogs(auditLogsApiGetAuditLogsRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<GetAuditLogsResponse>> response = fireblocks.auditLogs().getAuditLogs(startTime, endTime, timePeriod, category, subject, event, user, userId, order, pageSize, pageCursor, cursor);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.audit_logs.get_audit_logs(start_time, end_time, time_period, category, subject, event, user, user_id, order, page_size, page_cursor, cursor);
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<GetAuditLogsResponse>> = fireblocks.auditLogs.getAuditLogs(auditLogsApiGetAuditLogsRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<GetAuditLogsResponse>> response = fireblocks.auditLogs().getAuditLogs(startTime, endTime, timePeriod, category, subject, event, user, userId, order, pageSize, pageCursor, cursor);
      - lang: Python
        source: response = fireblocks.audit_logs.get_audit_logs(start_time, end_time, time_period, category, subject, event, user, user_id, order, page_size, page_cursor, cursor);
components:
  responses:
    Error:
      description: Error Response
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSchema'
  schemas:
    AuditLogData:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the audit log
        timestamp:
          type: number
          description: The timestamp of the audit log
        createdAt:
          type: number
          description: The timestamp of the audit log creation
        user:
          type: string
          description: The user who performed the action
        subject:
          type: string
          description: The subject of the action
        event:
          type: string
          description: The event that was performed
        category:
          type: string
          description: The category of the audit event
          example: Administration
        tenantId:
          type: string
          description: The tenant ID of the audit log
        userId:
          type: string
          description: The user ID of the audit log
    ErrorSchema:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
    AuditLogsData:
      type: array
      items:
        $ref: '#/components/schemas/AuditLogData'
    GetAuditLogsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/AuditLogsData'
        next:
          type:
          - string
          - 'null'
          description: Cursor to pass as pageCursor in the next request. Null when no further pages exist.
          example: eyJpZCI6IjEyMzQ1NiJ9
        cursor:
          deprecated: true
          type:
          - string
          - 'null'
          description: Deprecated. Use next instead.
  headers:
    X-Request-ID:
      schema:
        type: string
      description: Unique ID correlated to the API request. Please provide it in any support ticket you create or on Github issues related to Fireblocks SDKs
  securitySchemes:
    bearerTokenAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-readme:
  explorer-enabled: false
  samples-languages:
  - curl
  - javascript
  - python
x-provenance:
  method: harvested
  publisher: Fireblocks
  source: https://swagger.fireblocks.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)