Printago API
PATCH /v1/fuse/clients/{clientId}

PATCH /v1/fuse/clients/{clientId}

PATCH /v1/fuse/clients/:clientId Rename a Fuse client or change its own settings. The new settings are pushed to the client right away.

Requires: settings.edit

Path Parameters

clientId required
string

Request Body

FuseClientUpdate
nameoptionalnullable
string
settingsoptional
object
Make all properties in T optional
fileCacheGboptional
number
Disk budget for cached print files.
min: 0.1max: 100
selfHostedDetectoroptionalnullable
object
The Obico ML API this client uses when the store's detector is `obico-ml-api`. A LAN address, so it cannot be store-wide.
tokenrequired
string
urlrequired
string
statsWebSocketoptional
boolean
The local real-time stats WebSocket server for other LAN software.
timelapseCacheGboptional
number
Disk budget for finished timelapses kept for local browsing.
min: 0.1max: 100

Example Request

application/json 
{
  "name": "string",
  "settings": {
    "statsWebSocket": true,
    "fileCacheGb": 0.1,
    "timelapseCacheGb": 0.1,
    "selfHostedDetector": {
      "url": "string",
      "token": "string"
    }
  }
}

Response Schema

FuseClientInfo
clientIdrequired
string
createdAtrequired
string
format: date-time
idrequired
string
pattern: ^[a-z0-9]{24}$
ipAddressrequirednullable
string
lastSeenrequirednullable
string
format: date-time
managesSettingsrequired
boolean
False while the client runs a build that still configures cameras and AI locally.
namerequirednullable
string
platformrequirednullable
string
revokedAtrequirednullable
string
format: date-time
settingsrequired
object
Settings that belong to one Fuse installation: what it runs on its host and what it can reach on its LAN.
fileCacheGbrequired
number
Disk budget for cached print files.
min: 0.1max: 100
selfHostedDetectorrequirednullable
object
The Obico ML API this client uses when the store's detector is `obico-ml-api`. A LAN address, so it cannot be store-wide.
tokenrequired
string
urlrequired
string
statsWebSocketrequired
boolean
The local real-time stats WebSocket server for other LAN software.
timelapseCacheGbrequired
number
Disk budget for finished timelapses kept for local browsing.
min: 0.1max: 100
settingsAppliedAtrequirednullable
string
format: date-time
settingsAppliedVersionrequirednullable
string
Content version the client last reported applying; null before its first report.
settingsVersionrequired
string
Content version of the settings the cloud currently wants this client to run.
storeIdrequired
string
pattern: ^[a-z0-9]{24}$
systemInforequirednullable
object
Host/system details a Fuse client self-reports on token refresh. All fields optional so the client can send whatever it can determine and older clients (which send nothing) are unaffected.
archoptional
string
cpuCountoptional
number
cpuModeloptional
string
hostnameoptional
string
isDockeroptional
boolean
isElectronoptional
boolean
nodeVersionoptional
string
osoptional
string
osReleaseoptional
string
totalMemoryMboptional
number
updatedAtrequired
string
format: date-time
versionrequirednullable
string

Example Response

200 OK — application/json 
{
  "id": "string",
  "storeId": "string",
  "clientId": "string",
  "name": "string",
  "lastSeen": "2025-01-15T12:00:00.000Z",
  "revokedAt": "2025-01-15T12:00:00.000Z",
  "ipAddress": "string",
  "version": "string",
  "platform": "string",
  "systemInfo": {
    "os": "string",
    "osRelease": "string",
    "arch": "string",
    "hostname": "string",
    "nodeVersion": "string",
    "cpuModel": "string",
    "cpuCount": 1,
    "totalMemoryMb": 1,
    "isDocker": true,
    "isElectron": true
  },
  "settings": {
    "statsWebSocket": true,
    "fileCacheGb": 0.1,
    "timelapseCacheGb": 0.1,
    "selfHostedDetector": {
      "url": "string",
      "token": "string"
    }
  },
  "settingsVersion": "string",
  "settingsAppliedVersion": "string",
  "settingsAppliedAt": "2025-01-15T12:00:00.000Z",
  "managesSettings": true,
  "createdAt": "2025-01-15T12:00:00.000Z",
  "updatedAt": "2025-01-15T12:00:00.000Z"
}