> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fly.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Watch Filesystem

> Watch for filesystem changes via WebSocket.



## AsyncAPI

````yaml sprites/api/asyncapi.json fsWatch
id: fsWatch
title: Watch Filesystem
description: Watch for filesystem changes via WebSocket.
servers:
  - id: production
    protocol: wss
    host: api.sprites.dev
    bindings: []
    variables: []
address: /v1/sprites/{name}/fs/watch
parameters:
  - id: name
    jsonSchema:
      type: string
      description: Sprite name within the organization.
    description: Sprite name within the organization.
    type: string
    required: true
    deprecated: false
bindings: []
operations:
  - &ref_2
    id: fsWatchReceive
    title: 'Watch Filesystem: messages from client'
    description: Messages the Sprites API receives from the client.
    type: receive
    messages:
      - &ref_4
        id: WatchMessage
        contentType: application/json
        payload:
          - name: WatchMessage
            type: object
            properties:
              - name: type
                type: string
                required: true
              - name: paths
                type: array
                required: false
                properties:
                  - name: item
                    type: string
                    required: false
              - name: recursive
                type: boolean
                required: false
              - name: workingDir
                type: string
                required: false
              - name: path
                type: string
                required: false
              - name: event
                type: string
                required: false
              - name: timestamp
                type: string
                required: false
              - name: size
                type: integer
                required: false
              - name: isDir
                type: boolean
                required: false
              - name: message
                type: string
                required: false
        headers: []
        jsonPayloadSchema: &ref_0
          type: object
          properties:
            type:
              type: string
              x-parser-schema-id: <anonymous-schema-35>
            paths:
              type: array
              items:
                type: string
                x-parser-schema-id: <anonymous-schema-37>
              x-parser-schema-id: <anonymous-schema-36>
            recursive:
              type: boolean
              x-parser-schema-id: <anonymous-schema-38>
            workingDir:
              type: string
              x-parser-schema-id: <anonymous-schema-39>
            path:
              type: string
              x-parser-schema-id: <anonymous-schema-40>
            event:
              type: string
              x-parser-schema-id: <anonymous-schema-41>
            timestamp:
              type: string
              x-parser-schema-id: <anonymous-schema-42>
            size:
              type: integer
              format: int64
              x-parser-schema-id: <anonymous-schema-43>
            isDir:
              type: boolean
              x-parser-schema-id: <anonymous-schema-44>
            message:
              type: string
              x-parser-schema-id: <anonymous-schema-45>
          required:
            - type
          x-parser-schema-id: WatchMessage
        title: Watch message
        example: |-
          {
            "type": "<string>",
            "paths": {
              "item": "<string>"
            },
            "recursive": true,
            "workingDir": "<string>",
            "path": "<string>",
            "event": "<string>",
            "timestamp": "<string>",
            "size": 123,
            "isDir": true,
            "message": "<string>"
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: WatchMessage
    bindings: []
    extensions: &ref_1
      - id: x-parser-unique-object-id
        value: fsWatch
  - &ref_3
    id: fsWatchSend
    title: 'Watch Filesystem: messages to client'
    description: Messages the Sprites API sends to the client.
    type: send
    messages:
      - &ref_5
        id: WatchMessage
        contentType: application/json
        payload:
          - name: WatchMessage
            type: object
            properties:
              - name: type
                type: string
                required: true
              - name: paths
                type: array
                required: false
                properties:
                  - name: item
                    type: string
                    required: false
              - name: recursive
                type: boolean
                required: false
              - name: workingDir
                type: string
                required: false
              - name: path
                type: string
                required: false
              - name: event
                type: string
                required: false
              - name: timestamp
                type: string
                required: false
              - name: size
                type: integer
                required: false
              - name: isDir
                type: boolean
                required: false
              - name: message
                type: string
                required: false
        headers: []
        jsonPayloadSchema: *ref_0
        title: Watch message
        example: |-
          {
            "type": "<string>",
            "paths": {
              "item": "<string>"
            },
            "recursive": true,
            "workingDir": "<string>",
            "path": "<string>",
            "event": "<string>",
            "timestamp": "<string>",
            "size": 123,
            "isDir": true,
            "message": "<string>"
          }
        bindings: []
        extensions:
          - id: x-parser-unique-object-id
            value: WatchMessage
    bindings: []
    extensions: *ref_1
sendOperations:
  - *ref_2
receiveOperations:
  - *ref_3
sendMessages:
  - *ref_4
receiveMessages:
  - *ref_5
extensions:
  - id: x-parser-unique-object-id
    value: fsWatch
securitySchemes:
  - id: bearerAuth
    name: bearerAuth
    type: http
    description: >-
      Sprites API token in the form `<org>/<id>/<secret>`, sent as
      `Authorization: Bearer <token>` on the upgrade request.
    scheme: bearer
    extensions: []

````