# \ReleaseApi
All URIs are relative to *https://api.orangefox.download*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_release**](ReleaseApi.md#get_release) | **GET** /releases/get | Get Release
[**get_release_deprecated**](ReleaseApi.md#get_release_deprecated) | **GET** /releases/{release_id} | Get Release Short
[**get_releases**](ReleaseApi.md#get_releases) | **GET** /releases/ | Get Releases
[**get_updates_deprecated**](ReleaseApi.md#get_updates_deprecated) | **GET** /updates/{last_known_id} | Get Updates
## get_release
> models::ReleaseResponse get_release(release_id, _id, build_id, filename)
Get Release
Extended get device method, including the ability to get a device using device codename instead of the ID and Build ID. Example: /device/get?codename=lavender Calling this method without parameters will return the latest available release in the database Warning: the filename identification is deprecated! Use /release/<release_id> instead!
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**release_id** | Option<**String**> | Release ID | |
**_id** | Option<**String**> | Release ID (deprecated) | |
**build_id** | Option<**uuid::Uuid**> | Build ID, `ro.build.fox_id` prop | |
**filename** | Option<**String**> | | |
### Return type
[**models::ReleaseResponse**](ReleaseResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_release_deprecated
> models::ReleaseResponse get_release_deprecated(release_id)
Get Release Short
Gets release information using the release ID, nothing to discuss really.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**release_id** | **String** | | [required] |
### Return type
[**models::ReleaseResponse**](ReleaseResponse.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_releases
> models::ResponseGetReleases get_releases(id, _id, build_id, device_id, maintainer_id, codename, version, r#type, archived, freezed, after_release_id, after_date, sort, group, skip, limit)
Get Releases
Lists releases. This method contains a bunch of different parameters to filter releases for different cases. For example, you may use ?after_release_id param to get only releases that came after the last known one (aka get updates). You can filter releases by maintainer_id to get releases from a specific maintainer. This is the maintainer who released the build, not the current maintainer of the device. Getting releases by device codename is obsolete thought. The reason for this is that devices could change codenames eventually. Unfortunately, some OEMs and community make a total mess of them. Please use /device methods to determine the right device (preferably with the user decision), save the device ID somewhere and use it afterward. Version tag is deprecated for the same reason, it's not really consistent, as it might contain patch and mod versions and very different by each maintainer.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<[**Vec<String>**](String.md)> | Filter by Release IDs | |
**_id** | Option<[**Vec<String>**](String.md)> | Filter by Release IDs (deprecated) | |
**build_id** | Option<[**Vec<uuid::Uuid>**](Uuid__Uuid.md)> | Filter by Build IDs | |
**device_id** | Option<[**Vec<String>**](String.md)> | Filter by Device IDs | |
**maintainer_id** | Option<[**Vec<String>**](String.md)> | Filter by Maintainer IDs | |
**codename** | Option<[**Vec<String>**](String.md)> | Filter by device codenames | |
**version** | Option<[**Vec<String>**](String.md)> | Filter by release version | |
**r#type** | Option<[**Vec<models::ReleaseType>**](Models__ReleaseType.md)> | Filter by release type | |[default to ["stable","beta"]]
**archived** | Option<**bool**> | Filter by the archived status | |
**freezed** | Option<**bool**> | Filter by the freezed status | |
**after_release_id** | Option<**String**> | Show releases after the provided one | |
**after_date** | Option<**i32**> | Show releases after the provided timestamp | |
**sort** | Option<[**models::ReleasesSort**](Models__ReleasesSort.md)> | Sort mode | |[default to date_desc]
**group** | Option<**bool**> | Group releases by version + variant. This will change the response! | |
**skip** | Option<**i32**> | Skip query results | |
**limit** | Option<**i32**> | Limit query results (0 means unlimited) | |
### Return type
[**models::ResponseGetReleases**](Response_Get_Releases.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_updates_deprecated
> models::ListResponseShortReleaseResponse get_updates_deprecated(last_known_id, device_id, r#type, release_type, skip, limit)
Get Updates
Get updates method. Returns all new releases with release IDs. For example, \"/updates/<id>\" will return a list of all releases that were created after. You can also use \"device_id\" or / and \"release_type\" params. The first one will filter releases by specific devices, the second one will filter by release type. This can be useful, for example, if you want to notify users only with stable releases for this specific device. Warning: This method is obsolete! Please use /release/?after_release_id= instead!
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**last_known_id** | **String** | | [required] |
**device_id** | Option<[**Vec<String>**](String.md)> | Filter by device ID | |
**r#type** | Option<[**Vec<models::ReleaseType>**](Models__ReleaseType.md)> | Filter by release type | |[default to [stable, beta]]
**release_type** | Option<[**Vec<models::ReleaseType>**](Models__ReleaseType.md)> | Filter by release type (legacy) | |
**skip** | Option<**i32**> | Skip query results | |
**limit** | Option<**i32**> | Limit query results (0 means unlimited) | |
### Return type
[**models::ListResponseShortReleaseResponse**](ListResponse_ShortReleaseResponse_.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)