> ## 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.

# List catalog

> The known failures this farm can recognise



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /errors/catalog
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:
  /errors/catalog:
    get:
      tags:
        - Errors
      summary: List catalog
      description: The known failures this farm can recognise
      operationId: listErrorCatalog
      parameters:
        - schema:
            type: string
            description: Only the entries matched against this application
          required: false
          description: Only the entries matched against this application
          name: soft_id
          in: query
        - schema:
            type: boolean
            description: Only entries that are switched on
          required: false
          description: Only entries that are switched on
          name: enabled
          in: query
      responses:
        '200':
          description: The catalog
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorCatalogList'
        '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:
    ErrorCatalogList:
      type: array
      items:
        $ref: '#/components/schemas/ErrorCatalogEntry'
    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
    ErrorCatalogEntry:
      type: object
      properties:
        id:
          type: string
        tag:
          type: string
          description: >-
            What an occurrence of this failure is recorded under, and what joins
            a log line back to this entry
        soft_id:
          type: string
          default: ''
          description: >-
            The application whose output this is matched against. One entry, one
            DCC
        level:
          $ref: '#/components/schemas/ErrorLevel'
        title:
          type: string
          default: ''
        description:
          type: string
          default: ''
          description: 'Markdown: what this means and what to do about it'
        search:
          type: string
          description: The regular expression a log line is tested against
        samples:
          type: array
          items:
            type: string
          default: []
          description: >-
            Lines this pattern is meant to catch. The suite tests every shipped
            entry against its own
        enabled:
          type: boolean
          default: false
        origin:
          $ref: '#/components/schemas/ErrorCatalogOrigin'
        version:
          type: string
          default: 1.0.0
        author:
          type:
            - string
            - 'null'
        created_at:
          type: integer
          default: 0
          example: 1785846207000
        updated_at:
          type: integer
          default: 0
          example: 1785846207000
      required:
        - id
        - tag
        - level
        - search
        - soft_id
        - title
        - description
        - samples
        - enabled
        - version
        - created_at
        - updated_at
    ErrorLevel:
      type: string
      enum:
        - info
        - warning
        - critical
        - fatal
    ErrorCatalogOrigin:
      type: string
      enum:
        - shipped
        - studio
      default: studio
      description: >-
        `shipped` came with the build and an upgrade may replace it; `studio` is
        the operator's own
  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.