|
| 1 | +# 🚀 Winget-Repo REST API Documentation |
| 2 | + |
| 3 | +This document provides a complete overview of all available REST API endpoints for the **Winget-Repo** service. |
| 4 | + |
| 5 | +## 📑 Documentation |
| 6 | +1. Login to Winget-Repo |
| 7 | +2. Open the Server Settings |
| 8 | +3. Click the Ethernet Symbol in the upper right corner |
| 9 | + |
| 10 | +## 🔐 Authentication |
| 11 | + |
| 12 | +### **POST /login** |
| 13 | + |
| 14 | +Authenticate a user and receive a **Bearer token**. |
| 15 | +- Token lifetime: **1 hour** |
| 16 | +- Token is suspended after **1 hour of inactivity** |
| 17 | + |
| 18 | +### **POST /logout** |
| 19 | + |
| 20 | +Invalidate the currently active Bearer token. |
| 21 | + |
| 22 | +### **GET /test** |
| 23 | + |
| 24 | +Check API availability and validate Bearer authentication. |
| 25 | +- **Requires Bearer Token** |
| 26 | + |
| 27 | +## 🖥️ Winget-Repo Client |
| 28 | + |
| 29 | +### **POST /client_version** |
| 30 | + |
| 31 | +Retrieve the latest Winget-Repo Client version. |
| 32 | +- **Requires Bearer Token** |
| 33 | +- Also requires **Client Authentication Token** when client authentication is enabled |
| 34 | + |
| 35 | +## 📦 Packages |
| 36 | + |
| 37 | +### **POST /get_packages** |
| 38 | + |
| 39 | +Retrieve all packages including versions and Base64-encoded logos. |
| 40 | +- **Requires Bearer Token** |
| 41 | +- Also requires **Client Authentication Token** when enabled |
| 42 | + |
| 43 | +### **POST /add_package** |
| 44 | + |
| 45 | +Create a new package. |
| 46 | +- **Requires Bearer Token** |
| 47 | + |
| 48 | +### **PATCH /edit_package/{package_id}** |
| 49 | + |
| 50 | +Edit an existing package. |
| 51 | +- **Requires Bearer Token** |
| 52 | + |
| 53 | +### **DELETE /delete_package/{package_id}** |
| 54 | + |
| 55 | +Delete a package. |
| 56 | +- **Requires Bearer Token** |
| 57 | + |
| 58 | +## 🔢 Package Versions |
| 59 | + |
| 60 | +### **GET /get_package_versions/{package_id}** |
| 61 | + |
| 62 | +Retrieve all versions of a specific package. |
| 63 | +- **Requires Bearer Token** |
| 64 | + |
| 65 | +### **GET /get_specific_package_version/{version_uid}** |
| 66 | + |
| 67 | +Retrieve detailed information about a specific package version. |
| 68 | +- **Requires Bearer Token** |
| 69 | + |
| 70 | +### **POST /add_package_version/{package_id}** |
| 71 | + |
| 72 | +Add a new version to an existing package. |
| 73 | +- **Requires Bearer Token** |
| 74 | + |
| 75 | +### **DELETE /delete_package_version/{package_id}** |
| 76 | + |
| 77 | +Delete one or multiple package versions. |
| 78 | +- **Requires Bearer Token** |
0 commit comments