foxclient 6.1.0

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

Rust API client for foxclient

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.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 6.1.0
  • Package version: 6.1.0
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named foxclient and add the following to Cargo.toml under [dependencies]:

foxclient = { path = "./foxclient" }

Documentation for API Endpoints

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

Class Method HTTP request Description
DeviceApi get_device GET /devices/get GET /devices/get - Get a single device by device_id, codename, or _id.
DeviceApi get_device_by_id GET /devices/{device_id} GET /devices/{device_id} - Get device by ID (deprecated).
DeviceApi get_oems GET /oems GET /oems - Get a list of all unique OEM names.
DeviceApi list_devices GET /devices GET /devices/ - List devices with filters.
PasteApi create_paste POST /paste POST /paste/ - Create a new paste.
PasteApi get_paste GET /paste/{paste_id} GET /paste/{paste_id} - Get a paste by ID.
ReleaseApi download_release GET /release/{release_id}/dl GET /release/{release_id}/dl - Download a release binary.
ReleaseApi get_release GET /releases/get GET /releases/get - Get a single release.
ReleaseApi get_release_by_id GET /releases/{release_id} GET /releases/{release_id} - Get release by ID (deprecated).
ReleaseApi get_updates_after GET /updates/{last_known_id} GET /updates/{last_known_id} - Get releases after a given release ID (deprecated).
ReleaseApi list_releases GET /releases Check if a release version qualifies as "featured" (R12+). Build a full ReleaseResponse from a Release. GET /releases/ - List releases with filters.
ReportApi new_report POST /report/{release_id} POST /report/{release_id} - Submit a bug report.
StatsApi get_global_stats GET /stats GET /stats/ - Get global download statistics.
UptimeApi get_uptime GET /uptime GET /uptime - Aggregated public infrastructure status.
WikiApi get_asset GET /wiki/{site}/assets/{path} GET /wiki/{site}/assets/{path} - Serve asset bytes.
WikiApi get_page GET /wiki/{site}/pages/{path} GET /wiki/{site}/pages/{path} - Fetch one published page.
WikiApi get_site GET /wiki/sites/{slug} GET /wiki/sites/{slug} - Fetch one wiki site.
WikiApi list_pages GET /wiki/{site}/pages GET /wiki/{site}/pages - List every published page in a site.
WikiApi list_sites GET /wiki/sites GET /wiki/sites - List wiki sites.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

admin@orangefox.tech