uup-dump/json-api
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved readme

Browse Source
This commit is contained in:
awuctl 2020-03-11 10:27:18 +01:00
parent 365ab64480
commit 92bc671768
1 changed files with 28 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
readme.md
View File

@ -2,11 +2,11 @@ UUP dump JSON API
----------------- -----------------
### Description ### Description
A simple endpoint allowing access of the UUP dump API using HTTP requests. A simple endpoint allowing access to the UUP dump API using simple HTTP GET requests.
### Usage ### Usage
All requests are done using GET requests with parameters specified in the URL. All requests are done using GET requests with parameters specified in the URL.
Response is provided as an JSON. Responses are provided in JSON format.
Example response: Example response:
```json ```json
@ -36,68 +36,72 @@ Parameters:
- None - None
#### `/listid.php` #### `/listid.php`
Returns a list of builds in the local database. Returns a list of builds in the local database. (like "Browse the list of known builds" on the website)
Parameters: Parameters:
- `search` - Search query (optional) - `search` - Optional search query
- **Supported values:** any text - **Supported values:** any text
- `sortByDate` - Sort results by creation date (optional) - `sortByDate` - Optional sorting results by creation date
- **Supported values:** 0 = Disable, 1 = Enable - **Supported values:** 0 = Disable, 1 = Enable
#### `/fetchupd.php` #### `/fetchupd.php`
Fetches the latest builds from Windows Update servers using specified Fetches the latest builds from Windows Update servers using specified
parameters. parameters. (like "Fetch the latest build" on the website)
Parameters: Parameters:
- `arch` - Architecture of build to find - `arch` - Specifies which architecture the API will return.
- **Supported values:** `amd64`, `arm64`, `x86` - **Supported values:** `amd64`, `arm64`, `x86`
- `ring` - Ring to use when fetching information - `ring` - Specifies the ring the API uses when querying Windows Update servers.
- **Supported values:** `WIF`, `WIS`, `RP`, `RETAIL` - **Supported values:** `WIF`, `WIS`, `RP`, `RETAIL`
- `WIF` - Windows Insider Fast
- `WIS` - Windows Insider Slow
- `RP` - Release Preview
- `RETAIL` - Retail
- `flight` - Flight to use when fetching information - `flight` - Flight to use when fetching information
- **Supported values:** `Active`, `Skip`, `Current` - **Supported values:** `Active`, `Skip`, `Current`
- **NOTE:** `Skip` is for `WIF` ring only. `Current` is for `RP` ring only. - **NOTE:** `Skip` is for `WIF` ring only. `Current` is for `RP` ring only.
- `build` - Build number to use when fetching information - `build` - Build number to use by the API when fetching information
- **Supported values:** >= 9841 and <= PHP_INT_MAX-1 - **Supported values:** >= 9841 and <= PHP_INT_MAX-1
- `sku` - SKU number to use when fetching information - `sku` - SKU number to use when fetching information
- **Supported values:** Any integer - **Supported values:** Any SKU integer
#### `/get.php` #### `/get.php`
Retrieves download links for specified Update ID and provides lists of ready to Retrieves download links for specified Update ID and provides lists of ready to
use UUP sets. use UUP sets.
Parameters: Parameters:
- `id` - Update identifier - `id` - Update identifier (UUIDv4 string)
- **Supported values:** any update identifier - **Supported values:** Any valid update identifier in the UUIDv4 format.
- `lang` - Create UUP set for selected language (optional) - `lang` - Create UUP set for selected language (optional)
- **Supported values:** language name in xx-xx format - **Supported values:** language name in xx-xx format
- `edition` - Create UUP set for selected edition (optional) - `edition` - Create UUP set for the selected edition (optional)
- **Supported values:** any edition name - **Supported values:** Any edition name
- **NOTE:** You need to specify `lang` to get successful request - **NOTE:** Must be used with `lang`
- `noLinks` - Do not retrieve download links for created UUP set (optional) - `noLinks` - Do not retrieve download links for the created UUP set (optional)
- **Supported values:** 0 = Disable, 1 = Enable - **Supported values:** 0 = Disable, 1 = Enable
#### `/listlangs.php` #### `/listlangs.php`
Lists available languages for specified Update ID Lists available languages for the specified Update ID.
Parameters: Parameters:
- `id` - Update identifier (optional) - `id` - Optional Update identifier (UUIDv4 string)
- **Supported values:** any update identifier - **Supported values:** Any valid update identifier in the UUIDv4 format.
#### `/listlangs.php` #### `/listlangs.php`
Lists available editions for specified Update ID Lists available editions for the specified Update ID.
Parameters: Parameters:
- `lang` - Generate list for selected language - `lang` - Generate edition list for the selected language
- **Supported values:** language name in xx-xx format - **Supported values:** Language name in xx-xx format
- `id` - Update identifier (optional) - `id` - Optional update identifier (UUIDv4 string)
- **Supported values:** any update identifier - **Supported values:** Any valid update identifier in the UUIDv4 format.