> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulze.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Log

> Query the audit log. Credentials, membership, policy, and anything refused



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /audit
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /audit:
    get:
      tags:
        - Audit
      summary: Log
      description: >-
        Query the audit log. Credentials, membership, policy, and anything
        refused
      operationId: getAuditLog
      parameters:
        - schema:
            type: string
            description: Prefix match, so `api-key` covers create and delete
          required: false
          description: Prefix match, so `api-key` covers create and delete
          name: action
          in: query
        - schema:
            type: string
            description: >-
              The credential's row id. A name is a label. Resolve it to an id
              first.
          required: false
          description: >-
            The credential's row id. A name is a label. Resolve it to an id
            first.
          name: actor
          in: query
        - schema:
            type: string
            description: >-
              Comma-separated: `user`, `api-key`, `node`, `install`, `system`,
              `anonymous`
          required: false
          description: >-
            Comma-separated: `user`, `api-key`, `node`, `install`, `system`,
            `anonymous`
          name: actor_kind
          in: query
        - schema:
            type: string
            description: 'Comma-separated: `success`, `denied`, `failure`'
          required: false
          description: 'Comma-separated: `success`, `denied`, `failure`'
          name: outcome
          in: query
        - schema:
            type: string
            description: 'Comma-separated: what was acted on. `node`, `job`, `api-key`…'
          required: false
          description: 'Comma-separated: what was acted on. `node`, `job`, `api-key`…'
          name: target
          in: query
        - schema:
            type: string
            description: …and which one. Everything that happened to this machine.
          required: false
          description: …and which one. Everything that happened to this machine.
          name: target_id
          in: query
        - schema:
            type:
              - number
              - 'null'
          required: false
          name: from
          in: query
        - schema:
            type:
              - number
              - 'null'
          required: false
          name: to
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 1000
          required: false
          name: limit
          in: query
        - schema:
            type:
              - number
              - 'null'
            description: 'Cursor: the page after this entry'
          required: false
          description: 'Cursor: the page after this entry'
          name: before_at
          in: query
        - schema:
            type: string
          required: false
          name: before_id
          in: query
      responses:
        '200':
          description: Matching entries, newest first
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    AuditPage:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/AuditEntry'
        has_more:
          type: boolean
        next_at:
          type:
            - number
            - 'null'
          description: Feed back as `before_at` for the next page
        next_id:
          type:
            - string
            - 'null'
          description: Feed back as `before_id`; breaks ties inside a millisecond
      required:
        - entries
        - has_more
        - next_at
        - next_id
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    AuditEntry:
      type: object
      properties:
        at:
          type: number
        class:
          type: string
          enum:
            - security
            - action
          description: >-
            Which log the entry belongs to. Absent on entries written before
            classes existed
        action:
          type: string
          example: api-key.create
        outcome:
          type: string
          enum:
            - success
            - failure
            - denied
        actor:
          type: object
          properties:
            kind:
              type: string
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
          required:
            - kind
        target:
          type:
            - object
            - 'null'
          properties:
            type:
              type: string
            id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
          required:
            - type
        source:
          type:
            - object
            - 'null'
          properties:
            ip:
              type:
                - string
                - 'null'
            node:
              type:
                - string
                - 'null'
            route:
              type:
                - string
                - 'null'
        detail:
          type:
            - object
            - 'null'
          properties: {}
          additionalProperties: {}
      required:
        - at
        - action
        - outcome
        - actor
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.