v2 Reference (Preview)/Batches
Delete batch
Permanently delete a batch by number. Units associated with the batch will be disassociated but not deleted. No nested elements are removed.
API v2 Preview
The TofuPilot API v2.0 is currently in public preview and is subject to change as we stabilize until release (planned for Aug 2025).
Access
API Key | Access Level | Description |
---|---|---|
User | Full | Users can delete batches |
Station | Unauthorized | Stations cannot delete batches |
Endpoint
DELETE
/v2/batches/{number}
AuthorizationBearer <token>
API key for authentication. Use format: Bearer YOUR_API_KEY
In: header
Path Parameters
numberstring
Response Body
from tofupilot.v2 import TofuPilot
# Initialize the TofuPilot client
client = TofuPilot()
# Execute the operation
result = client.batches.delete(
number="string"
)
# Handle response
print(result)
{
"id": "550e8400-e29b-41d4-a716-446655440000"
}
{
"code": "NOT_FOUND",
"message": "Procedure not found: {id}",
"issues": []
}
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}
How is this guide?