TofuPilotTofuPilot
API Reference (v2)Units

Update unit

Update unit properties including serial number, part revision, batch assignment, and file attachments with case-insensitive matching.

Access

API KeyAccess LevelDescription
UserFullUsers can update units
StationFullStations can update units

Endpoint

PATCH/v2/units/{serial_number}

Authorization

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

serial_numberstring

Serial number of the unit to update.

Request Body

new_serial_number?string

New serial number for the unit.

Match^[a-zA-Z0-9_.:+-]+$
Length1 <= length <= 60
part_number?string

New part number for the unit.

Match^[a-zA-Z0-9_.:+-]+$
Length1 <= length <= 60
revision_number?string

New revision number for the unit.

Match^[a-zA-Z0-9_.:+-]+$
Length1 <= length <= 60
batch_number?string | null

New batch number for the unit. Set to null to remove batch.

attachments?array<string>

Array of upload IDs to attach to the unit.

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.units.update(
    serial_number="string"
)

# Handle response
print(result)
{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}
{
  "message": "Unauthorized",
  "code": "UNAUTHORIZED",
  "issues": []
}
{
  "message": "Not found",
  "code": "NOT_FOUND",
  "issues": []
}
{
  "message": "Conflict",
  "code": "CONFLICT",
  "issues": []
}
{
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "issues": []
}

How is this guide?

List and filter units GET

Retrieve a paginated list of units with filtering by serial number, part number, and batch. Uses cursor-based pagination for efficient large dataset traversal.

Delete unit attachments DELETE

Delete attachments from a unit by their IDs. Removes the files from storage and unlinks them from the unit.