Releases API
Get WisPanel release information and manage releases.
List All Releases
GET /api/v1/releases
Query Parameters
| Parameter |
Type |
Description |
| channel |
string |
Filter by channel: stable, beta, dev |
| per_page |
integer |
Items per page (default: 10, max: 50) |
Response
{
"data": [
{
"version": "0.3.5",
"channel": "stable",
"released_at": "2026-01-20T10:00:00Z",
"release_notes": [
{
"type": "new",
"description": "Added Docker support"
}
]
}
]
}
Get Latest Release
GET /api/v1/releases/latest
Get Specific Release
GET /api/v1/releases/{version}
Create Release
POST /api/v1/releases
Request Body
{
"version": "0.3.6",
"channel": "stable",
"changelog": "## What's New\n\n- Feature A\n- Feature B",
"release_notes": [
{
"type": "new",
"description": "Added new feature A"
},
{
"type": "fixed",
"description": "Fixed bug in login"
}
],
"is_released": true,
"released_at": "2026-01-22T10:00:00Z"
}
Update Release
PUT /api/v1/releases/{version}
Request Body
{
"channel": "stable",
"changelog": "Updated changelog",
"release_notes": [
{
"type": "new",
"description": "Added feature X"
},
{
"type": "improved",
"description": "Better performance"
},
{
"type": "fixed",
"description": "Fixed crash on startup"
}
],
"is_released": true
}
Delete Release
DELETE /api/v1/releases/{version}
Release Note Types
| Type |
Description |
Color |
| new |
New feature |
Green |
| improved |
Enhancement |
Blue |
| fixed |
Bug fix |
Amber |
| security |
Security patch |
Red |
| breaking |
Breaking change |
Red |
| deprecated |
Deprecation notice |
Gray |
| removed |
Removed feature |
Gray |
| docs |
Documentation |
Violet |
| performance |
Performance improvement |
Yellow |
Example: Adding Multiple Release Notes
{
"release_notes": [
{ "type": "new", "description": "Added Docker support" },
{ "type": "new", "description": "Added backup scheduling" },
{ "type": "improved", "description": "Faster database queries" },
{ "type": "fixed", "description": "Fixed SSL renewal" },
{ "type": "fixed", "description": "Fixed timezone display" },
{ "type": "security", "description": "Patched XSS vulnerability" }
]
}
Example: Update Only Release Notes
PATCH /api/v1/releases/{version}
{
"release_notes": [
{ "type": "fixed", "description": "Hotfix for critical bug" }
]
}