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

Merge pull request #1 from awuctl/master

Browse Source 
Readme/Documentation improvements
This commit is contained in:
whatever127 2020-03-12 20:04:29 +01:00 committed by GitHub
commit eee322b007
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 154 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

202
readme.md
View File

@ -1,22 +1,11 @@
UUP dump JSON API # 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:
```json
{
"response": {
"apiVersion": "1.27.0"
},
"jsonApiVersion": "0.1.0-alpha"
}
```
Responses from the UUP dump API are always returned in the `response` key. Responses from the UUP dump API are always returned in the `response` key.
@ -28,76 +17,193 @@ If request fails, a HTTP error code will be set to:
In such cases `response` key will contain an `error` key with short description In such cases `response` key will contain an `error` key with short description
of the error. of the error.
### Supported endpoints ## Supported endpoints
#### `/` or `/index.php` ### `/` or `/index.php`
Returns versions of APIs Returns versions of both JSON and UUP dump APIs
Parameters: Parameters:
- None - None
#### `/listid.php` #### JSON response format:
Returns a list of builds in the local database. ```javascript
{
"response": {
"apiVersion":"string" // Current UUP dump API version
},
"jsonApiVersion": "string" // Current JSON API version
}
```
### `/listid.php`
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` #### JSON response format:
```javascript
{
"response": {
"apiVersion":"string", // Current UUP dump API version
"builds": [
{
"title": "string", // Update title, for example Windows 10 Insider Preview 19577.1000 (rs_prerelease)
"build": "string", // Update build number, for example 19577.1000
"arch": " string", // Update architecture, for example amd64
"created": 1234567890, // Timestamp of when the build was added to the database
"uuid": "string" // UUID Update Identifier
},
...
]
},
"jsonApiVersion": "string" // Current JSON API version
}
```
### `/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` #### JSON response format:
```javascript
{
"response": {
"apiVersion": "string", // Current UUP dump API version
"updateId": "string", // UUID Update Identifier
"updateTitle": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease)
"foundBuild": "string", // Update build number, such as 19577.1000
"arch": "string", // Update architecture, such as amd64/x86/arm64
"fileWrite": "string", // NO_SAVE if the build was already in the database, INFO_WRITTEN if it was just added to it.
"updateArray": [
{
"updateId": "string", // UUID Update Identifier
"updateTitle": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease)
"foundBuild": "string", // Update build number, such as 19577.1000
"arch": "string", // Update architecture, such as amd64/x86/arm64
"fileWrite": "string" // NO_SAVE if the build was already in the database, INFO_WRITTEN if it was just added to it.
}
]
},
"jsonApiVersion": "string" // Current JSON API version
}
```
### `/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 (UUID string)
- **Supported values:** any update identifier - **Supported values:** Any valid update identifier in the UUID format, may include revision in the following format: "UUID_rev.2".
- `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 (Retrieve links), 1 = Enable (No links)
#### `/listlangs.php` #### JSON response format:
Lists available languages for specified Update ID ```javascript
{
"response": {
"apiVersion": "string", // Current UUP dump API version
"updateName": "string", // Update title, such as Windows 10 Insider Preview 19577.1000 (rs_prerelease)
"arch": "string", // Update architecture, for example x86
"build": "string", // Update build number, for example 19577.1000
"files": { // All files contained in the package
"string": { // File name, such as 'core_en-us.esd', 'microsoft-windows-client-features-package.esd', etc.
"sha1": "string", // The file's SHA1 checksum.
"size": "string", // File size in bytes
"url": "string", // File download link, 'null' if noLinks=1
"uuid": "string", // File UUIDv4, 'null' if noLinks=1 used
"expire": "string", // Link expiration date, '0' if noLinks=1 used
"debug": "string" // Raw data from Microsoft servers, 'null' if noLinks=1 used
},
...
}
},
"jsonApiVersion": "string" // Current JSON API version
}
```
### `/listlangs.php`
Lists available languages for the specified Update ID.
Parameters: Parameters:
- `id` - Update identifier (optional) - `id` - Optional Update identifier (UUID string)
- **Supported values:** any update identifier - **Supported values:** Any valid update identifier in the UUID format, may include revision in the following format: "UUID_rev.2".
#### JSON response format:
```javascript
{
"response": {
"apiVersion": "string", // Current UUP dump API version
"langList": [
"en-gb", // Short language name, xx-xx format.
...
],
"langFancyNames": {
"en-gb": "English (United Kingdom)", // key-value pairs of xx-xx to full language name.
...
}
},
"jsonApiVersion": "string" // Current JSON API version
}
```
#### `/listlangs.php` ### `/listeditions.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 (UUID string)
- **Supported values:** any update identifier - **Supported values:** Any valid update identifier in the UUID format, may include revision in the following format: "UUID_rev.2".
#### JSON response format:
```javascript
{
"response": {
"apiVersion": "string", // Current UUP dump API version
"editionList": [
"CLOUD", // Short edition name
...
],
"editionFancyNames": {
"CLOUD": "Windows 10 S", // key-value pairs of edition name to fancy edition name.
...
}
},
"jsonApiVersion": "string" // Current JSON API version
}
```