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

# Retrieve

> Get a node by id



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /nodes/{id}
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:
  /nodes/{id}:
    get:
      tags:
        - Nodes
      summary: Retrieve
      description: Get a node by id
      operationId: getNode
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          required: true
          name: id
          in: path
        - schema:
            type: boolean
            description: Join hardware, software and benchmark data
            default: false
          required: false
          description: Join hardware, software and benchmark data
          name: extend
          in: query
      responses:
        '200':
          description: The node
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Node'
        '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'
        '404':
          description: Not found
          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:
    Node:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        system_id:
          type: string
        name:
          type: string
        alias:
          type:
            - string
            - 'null'
        color:
          type: string
        pool_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        group_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        tags:
          type: array
          items:
            type: string
        type:
          $ref: '#/components/schemas/NodeType'
        user_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        users:
          type: array
          items:
            $ref: '#/components/schemas/NodeUser'
          description: >-
            Everyone signed in at this machine with the desktop app open; absent
            until one has been
        license:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        status:
          $ref: '#/components/schemas/NodeStatus'
        info:
          type: string
        version:
          type:
            - string
            - 'null'
        last_seen:
          type:
            - integer
            - 'null'
          example: 1785846207000
        job:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              pattern: ^[a-fA-F0-9]{24}$
              example: 68b1f0c2a4d3e5f6a7b8c9d0
            step_id:
              type: string
              pattern: ^[a-fA-F0-9]{24}$
              example: 68b1f0c2a4d3e5f6a7b8c9d0
            tasks:
              type: array
              items:
                type: string
                pattern: ^[a-fA-F0-9]{24}$
                example: 68b1f0c2a4d3e5f6a7b8c9d0
          required:
            - id
            - step_id
            - tasks
        alive:
          type: number
        idle_since:
          type:
            - integer
            - 'null'
          example: 1785846207000
        cloud:
          type:
            - object
            - 'null'
          properties:
            fleet_id:
              type: string
              pattern: ^[a-fA-F0-9]{24}$
              example: 68b1f0c2a4d3e5f6a7b8c9d0
            instance_id:
              type: string
          required:
            - fleet_id
            - instance_id
          description: >-
            The cloud machine this node runs on, when a connected scale set
            started it
        ephemeral:
          type: boolean
          description: >-
            Removed from the farm once it has been offline long enough for its
            work to be handed back
        spawner:
          type:
            - object
            - 'null'
          properties:
            job_id:
              type:
                - string
                - 'null'
              pattern: ^[a-fA-F0-9]{24}$
              example: 68b1f0c2a4d3e5f6a7b8c9d0
            soft_id:
              type: string
            version:
              type: string
            type:
              type: string
            status:
              type: string
          required:
            - job_id
            - soft_id
            - version
            - type
            - status
        hardware:
          $ref: '#/components/schemas/Hardware'
        software:
          type: array
          items:
            $ref: '#/components/schemas/Software'
        benchmarks:
          type: array
          items:
            $ref: '#/components/schemas/BenchmarkResult'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/NodeError'
        user:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            name:
              type: string
            alias:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - alias
      required:
        - id
        - system_id
        - name
        - alias
        - color
        - pool_id
        - group_id
        - tags
        - type
        - user_id
        - license
        - status
        - info
        - version
        - last_seen
        - job
    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
    NodeType:
      type: string
      enum:
        - monitor
        - node
        - workstation
        - server
        - test
    NodeUser:
      type: object
      properties:
        user_id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        away:
          type: boolean
          default: false
          description: Their session is disconnected or locked (Windows)
      required:
        - user_id
    NodeStatus:
      type: string
      enum:
        - offline
        - loading
        - reserved
        - suspended
        - idle
        - busy
        - finishing
        - error
    Hardware:
      type: object
      properties:
        os:
          anyOf:
            - $ref: '#/components/schemas/OperatingSystem'
            - type: 'null'
          default: null
        cpu:
          anyOf:
            - $ref: '#/components/schemas/Cpu'
            - type: 'null'
          default: null
        gpu:
          type: array
          items:
            $ref: '#/components/schemas/Gpu'
          default: []
        ram:
          anyOf:
            - $ref: '#/components/schemas/Ram'
            - type: 'null'
          default: null
        system:
          anyOf:
            - $ref: '#/components/schemas/Machine'
            - type: 'null'
          default: null
        drives:
          type: array
          items:
            $ref: '#/components/schemas/Drive'
          default: []
        system_drive:
          anyOf:
            - $ref: '#/components/schemas/SystemDrive'
            - type: 'null'
          default: null
        network:
          type: array
          items:
            $ref: '#/components/schemas/NetworkInterface'
          default: []
        uptime:
          type:
            - number
            - 'null'
          default: null
        work_threads:
          type: integer
          default: 0
      required:
        - os
        - cpu
        - gpu
        - ram
        - system
        - drives
        - system_drive
        - network
        - uptime
        - work_threads
    Software:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        soft_id:
          type: string
          default: ''
        name:
          type: string
          default: ''
        version:
          type: string
          default: ''
        display_version:
          type: string
          default: ''
        type:
          $ref: '#/components/schemas/SoftwareType'
        paths:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                default: ''
              value:
                anyOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                  - type: 'null'
                default: null
        plugins:
          type: array
          items:
            $ref: '#/components/schemas/Software'
        default:
          type: boolean
        meta:
          type: object
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
      required:
        - type
        - soft_id
        - name
        - version
        - display_version
    BenchmarkResult:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        definition_id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
          description: The benchmark that measured it; it may since have been deleted
        type:
          $ref: '#/components/schemas/BenchmarkType'
        name:
          type: string
          description: The benchmark's name, kept with the score
        icon:
          type: string
          description: The vendor, or the application a Custom scene renders in
        value:
          type: number
        date:
          type: integer
          default: 0
          example: 1785846207000
        job_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          default: null
          example: 68b1f0c2a4d3e5f6a7b8c9d0
          description: The run that measured it; null when somebody typed it in
      required:
        - id
        - definition_id
        - type
        - name
        - icon
        - value
        - date
        - job_id
    NodeError:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        tag:
          type: string
        level:
          $ref: '#/components/schemas/ErrorLevel'
        title:
          type: string
        notify:
          $ref: '#/components/schemas/ErrorNotificationType'
        detail:
          type:
            - string
            - 'null'
        help:
          type:
            - string
            - 'null'
        captures:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
          description: >-
            What the matching pattern's groups read out of the line, keyed by
            number and by name
        variant:
          type:
            - string
            - 'null'
        node_id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        job_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        step_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        task_id:
          type:
            - string
            - 'null'
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        count:
          type: integer
          default: 1
        created_at:
          type: integer
          default: 0
          example: 1785846207000
        updated_at:
          type: integer
          default: 0
          example: 1785846207000
      required:
        - id
        - tag
        - level
        - title
        - node_id
        - count
        - created_at
        - updated_at
    OperatingSystem:
      type: object
      properties:
        platform:
          type: string
          default: ''
        distro:
          type: string
          default: ''
        release:
          type: string
          default: ''
        build:
          type: string
          default: ''
      required:
        - platform
        - distro
        - release
        - build
    Cpu:
      type: object
      properties:
        manufacturer:
          type: string
          default: ''
        brand:
          type: string
          default: ''
        speed:
          type: number
          default: 0
        cores:
          type: integer
          default: 0
        physical:
          type: integer
          default: 0
        processors:
          type: integer
          default: 0
        utilization:
          type:
            - number
            - 'null'
          default: null
        temperature:
          type:
            - number
            - 'null'
          default: null
      required:
        - manufacturer
        - brand
        - speed
        - cores
        - physical
        - processors
        - utilization
        - temperature
    Gpu:
      type: object
      properties:
        id:
          type: integer
        vendor:
          type: string
          default: ''
        model:
          type: string
          default: ''
        driver:
          type: string
          default: ''
        vram:
          type:
            - number
            - 'null'
          default: null
        vram_used:
          type:
            - number
            - 'null'
          default: null
        utilization:
          type:
            - number
            - 'null'
          default: null
        temperature:
          type:
            - number
            - 'null'
          default: null
      required:
        - id
        - vendor
        - model
        - driver
        - vram
        - vram_used
        - utilization
        - temperature
    Ram:
      type: object
      properties:
        total:
          type:
            - number
            - 'null'
          default: 0
        free:
          type:
            - number
            - 'null'
          default: 0
        used:
          type:
            - number
            - 'null'
          default: null
        layout:
          type: array
          items:
            $ref: '#/components/schemas/RamModule'
          default: []
      required:
        - total
        - free
        - used
        - layout
    Machine:
      type: object
      properties:
        manufacturer:
          type: string
          default: ''
        model:
          type: string
          default: ''
        virtual:
          type: boolean
          default: false
      required:
        - manufacturer
        - model
        - virtual
    Drive:
      type: object
      properties:
        id:
          type: integer
        name:
          type:
            - string
            - 'null'
          default: null
        local:
          type: string
          default: ''
        remote:
          type:
            - string
            - 'null'
          default: null
      required:
        - id
        - name
        - local
        - remote
    SystemDrive:
      type: object
      properties:
        mount:
          type: string
          default: ''
        total:
          type:
            - number
            - 'null'
          default: 0
        free:
          type:
            - number
            - 'null'
          default: 0
        used:
          type:
            - number
            - 'null'
          default: null
      required:
        - mount
        - total
        - free
        - used
    NetworkInterface:
      type: object
      properties:
        ip:
          type: string
          default: ''
        mac:
          type: string
          default: ''
        default:
          type: boolean
          default: false
        speed:
          type:
            - number
            - 'null'
          default: null
        type:
          type: string
          default: ''
        name:
          type: string
          default: ''
        internal:
          type: boolean
          default: false
        virtual:
          type: boolean
          default: false
      required:
        - ip
        - mac
        - default
        - speed
        - type
        - name
        - internal
        - virtual
    SoftwareType:
      type: string
      enum:
        - host
        - engine
        - plugin
        - system
        - utils
    BenchmarkType:
      type: string
      enum:
        - vray
        - vray-gpu
        - redshift
        - cinebench
        - blender
        - blender-gpu
        - custom
    ErrorLevel:
      type: string
      enum:
        - info
        - warning
        - critical
        - fatal
    ErrorNotificationType:
      type: string
      enum:
        - none
        - owner
        - admin
        - group
        - pool
        - all
      default: none
    RamModule:
      type: object
      properties:
        index:
          type: integer
        manufacturer:
          type: string
        type:
          type: string
          default: ''
        speed:
          type:
            - number
            - 'null'
          default: null
      required:
        - index
        - type
        - speed
  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.