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

# Alive

> Liveness probe (no credential required)



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /service/alive
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:
  /service/alive:
    get:
      tags:
        - Service
      summary: Alive
      description: Liveness probe (no credential required)
      operationId: getServiceAlive
      parameters:
        - schema:
            type: string
          required: false
          name: user
          in: query
      responses:
        '200':
          description: Current liveness
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceAlive'
        '400':
          description: Bad request
          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:
    ServiceAlive:
      type: object
      properties:
        service:
          type: boolean
        database:
          type: boolean
        status:
          anyOf:
            - $ref: '#/components/schemas/NodeStatus'
            - type: 'null'
        type:
          anyOf:
            - $ref: '#/components/schemas/NodeType'
            - type: 'null'
        version:
          type:
            - string
            - 'null'
          default: null
        build_type:
          type:
            - string
            - 'null'
        last_error:
          anyOf:
            - $ref: '#/components/schemas/ErrorData'
            - type: 'null'
        desktop:
          type: boolean
          default: false
        updated_at:
          type: integer
          example: 1785846207000
      required:
        - service
        - database
        - status
        - type
        - build_type
        - last_error
        - updated_at
        - version
        - desktop
    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
    NodeStatus:
      type: string
      enum:
        - offline
        - loading
        - reserved
        - suspended
        - idle
        - busy
        - finishing
        - error
    NodeType:
      type: string
      enum:
        - monitor
        - node
        - workstation
        - server
        - test
    ErrorData:
      type: object
      properties:
        tag:
          type: string
        level:
          $ref: '#/components/schemas/ErrorLevel'
        title:
          type: string
        detail:
          type: string
        help:
          type: string
        notify:
          $ref: '#/components/schemas/ErrorNotificationType'
      required:
        - tag
        - level
        - title
    ErrorLevel:
      type: string
      enum:
        - info
        - warning
        - critical
        - fatal
    ErrorNotificationType:
      type: string
      enum:
        - none
        - owner
        - admin
        - group
        - pool
        - all
      default: none
  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.