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

# Machines

> The fleet's machines as the provider lists them, with the node each one became



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /cloud/fleets/{id}/machines
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:
  /cloud/fleets/{id}/machines:
    get:
      tags:
        - Cloud
      summary: Machines
      description: >-
        The fleet's machines as the provider lists them, with the node each one
        became
      operationId: getCloudMachines
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Machines
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CloudMachine'
        '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:
    CloudMachine:
      type: object
      properties:
        instance_id:
          type: string
        machine_id:
          type:
            - string
            - 'null'
          description: The id the machine itself reports, which its node is matched by
        hostname:
          type:
            - string
            - 'null'
        state:
          type: string
        created_at:
          type:
            - integer
            - 'null'
          default: null
          example: 1785846207000
        detail:
          type:
            - string
            - 'null'
          default: null
          description: Why the provider says it failed
        node:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
            name:
              type: string
            status:
              $ref: '#/components/schemas/NodeStatus'
            version:
              type:
                - string
                - 'null'
          required:
            - id
            - name
            - status
            - version
      required:
        - instance_id
        - machine_id
        - hostname
        - state
        - node
        - created_at
        - detail
    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
  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.