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

# Update fleet

> Change a fleet's pool, order, mode or limits



## OpenAPI

````yaml /renderflow/api-reference/openapi.json patch /cloud/fleets/{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:
  /cloud/fleets/{id}:
    patch:
      tags:
        - Cloud
      summary: Update fleet
      description: Change a fleet's pool, order, mode or limits
      operationId: updateCloudFleet
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudFleetUpdate'
      responses:
        '200':
          description: The updated fleet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudFleet'
        '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:
    CloudFleetUpdate:
      type: object
      properties:
        pool_id:
          type:
            - string
            - 'null'
          description: The pool its machines join. Machines already running move with it
        order:
          type: integer
          minimum: 0
        mode:
          $ref: '#/components/schemas/FleetMode'
        min:
          type: integer
          minimum: 0
          maximum: 1000
        max:
          type: integer
          minimum: 0
          maximum: 1000
        idle_minutes:
          type: integer
          minimum: 1
          maximum: 1440
      additionalProperties: false
    CloudFleet:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        connection_id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        resource_id:
          type: string
        name:
          type: string
        region:
          type: string
        size:
          type: string
        spot:
          type: boolean
        os:
          type:
            - string
            - 'null'
          enum:
            - linux
            - windows
            - null
        capacity:
          type: integer
          description: Machines the scale set runs, as last read
        joined:
          type: integer
          default: 0
          description: Machines whose node is up; the rest of `capacity` is still starting
        pool_id:
          type:
            - string
            - 'null'
        order:
          type: integer
          description: Lower is asked first among a pool's fleets
        mode:
          $ref: '#/components/schemas/FleetMode'
        min:
          type: integer
        max:
          type: integer
        idle_minutes:
          type: integer
        profile:
          anyOf:
            - $ref: '#/components/schemas/CloudFleetProfile'
            - type: 'null'
        error:
          type:
            - string
            - 'null'
        failure:
          anyOf:
            - $ref: '#/components/schemas/CloudFailure'
            - type: 'null'
          default: null
        held_until:
          type:
            - integer
            - 'null'
          default: null
          example: 1785846207000
          description: >-
            Until then it adds no machine by itself: after a cancel, or after
            its machines never joined
        checked_at:
          type:
            - integer
            - 'null'
          example: 1785846207000
        created_at:
          type: integer
          example: 1785846207000
        updated_at:
          type: integer
          example: 1785846207000
      required:
        - id
        - connection_id
        - resource_id
        - name
        - region
        - size
        - spot
        - os
        - capacity
        - pool_id
        - order
        - mode
        - min
        - max
        - idle_minutes
        - profile
        - error
        - checked_at
        - created_at
        - updated_at
        - joined
        - failure
        - held_until
    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
    FleetMode:
      type: string
      enum:
        - manual
        - demand
      description: >-
        `manual`: someone sets the number of machines. `demand`: they start when
        work waits and go when idle
    CloudFleetProfile:
      type: object
      properties:
        cores:
          type:
            - number
            - 'null'
        memory_gb:
          type:
            - number
            - 'null'
        gpus:
          type: array
          items:
            type: string
        software:
          type: array
          items:
            $ref: '#/components/schemas/Software'
        version:
          type:
            - string
            - 'null'
        at:
          type: integer
          example: 1785846207000
      required:
        - cores
        - memory_gb
        - gpus
        - software
        - version
        - at
      description: >-
        What the test machine reported. The fleet only scales up for work these
        apps can render
    CloudFailure:
      type: object
      properties:
        at:
          type: integer
          example: 1785846207000
        message:
          type: string
        boot_log:
          type:
            - string
            - 'null'
          description: The end of a machine's console log, when it booted and never joined
      required:
        - at
        - message
        - boot_log
      description: Why machines did not become nodes. Cleared when one does
    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
    SoftwareType:
      type: string
      enum:
        - host
        - engine
        - plugin
        - system
        - utils
  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.