foxclient 6.0.2

Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application's access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

# \ReleaseApi

All URIs are relative to *https://api.orangefox.download*

Method | HTTP request | Description
------------- | ------------- | -------------
[**download_release**](ReleaseApi.md#download_release) | **GET** /release/{release_id}/dl | GET /release/{release_id}/dl - Download a release binary.
[**get_release**](ReleaseApi.md#get_release) | **GET** /releases/get | GET /releases/get - Get a single release.
[**get_release_by_id**](ReleaseApi.md#get_release_by_id) | **GET** /releases/{release_id} | GET /releases/{release_id} - Get release by ID (deprecated).
[**get_updates_after**](ReleaseApi.md#get_updates_after) | **GET** /updates/{last_known_id} | GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
[**list_releases**](ReleaseApi.md#list_releases) | **GET** /releases | GET /releases/ - List releases with filters.



## download_release

> download_release(release_id)
GET /release/{release_id}/dl - Download a release binary.

The API hosts release binaries itself (acting as its own mirror). Each successful download is recorded in the `stats` collection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**release_id** | **String** | Release ID | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/zip, 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

> models::ReleaseResponse get_release(id, _id, build_id, filename)
GET /releases/get - Get a single release.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<**String**> |  |  |
**_id** | Option<**String**> |  |  |
**build_id** | Option<**String**> |  |  |
**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_by_id

> models::ReleaseResponse get_release_by_id(release_id)
GET /releases/{release_id} - Get release by ID (deprecated).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**release_id** | **String** | Release ID | [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_updates_after

> models::ListResponseReleaseResponse get_updates_after(last_known_id)
GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).

Returns all non-archived releases that were created after the specified release's date.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**last_known_id** | **String** | Last known release ID | [required] |

### Return type

[**models::ListResponseReleaseResponse**](ListResponse_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)


## list_releases

> models::ListResponseReleaseResponse list_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/ - List releases with filters.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<**String**> |  |  |
**_id** | Option<**String**> |  |  |
**build_id** | Option<**String**> |  |  |
**device_id** | Option<**String**> |  |  |
**maintainer_id** | Option<**String**> |  |  |
**codename** | Option<**String**> |  |  |
**version** | Option<**String**> |  |  |
**r#type** | Option<**String**> |  |  |
**archived** | Option<**bool**> |  |  |
**freezed** | Option<**bool**> |  |  |
**after_release_id** | Option<**String**> |  |  |
**after_date** | Option<**i64**> |  |  |
**sort** | Option<**String**> |  |  |
**group** | Option<**bool**> |  |  |
**skip** | Option<**i64**> |  |  |
**limit** | Option<**i64**> |  |  |

### Return type

[**models::ListResponseReleaseResponse**](ListResponse_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)