foxinternalclient

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.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 6.1.1
  • Package version: 1.0.0
  • Generator version: 7.21.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import foxinternalclient

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import foxinternalclient

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import foxinternalclient
from foxinternalclient.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.orangefox.download
# See configuration.py for a list of all supported configuration parameters.
configuration = foxinternalclient.Configuration(
    host = "https://api.orangefox.download"
)



# Enter a context with an instance of the API client
async with foxinternalclient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = foxinternalclient.DeviceApi(api_client)
    device_id = 'device_id_example' # str |  (optional)
    codename = 'codename_example' # str |  (optional)
    id = 'id_example' # str |  (optional)

    try:
        # GET /devices/get - Get a single device by device_id, codename, or _id.
        api_response = await api_instance.get_device(device_id=device_id, codename=codename, id=id)
        print("The response of DeviceApi->get_device:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DeviceApi->get_device: %s\n" % e)

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.
FoxFactoryApi cancel_task POST /factory/{task_id}/cancel POST /internal/factory/{task_id}/cancel – Cancel a running build task.
FoxFactoryApi create_task POST /factory POST /internal/factory – Create a new build task.
FoxFactoryApi delete_task DELETE /factory/{task_id} DELETE /internal/factory/{task_id} – Delete a build task and its artifact.
FoxFactoryApi download_artifact GET /factory/{task_id}/artifact GET /internal/factory/{task_id}/artifact – Download a build artifact.
FoxFactoryApi get_factory_status GET /factory/status GET /internal/factory/status – Get the current FoxFactory worker status.
FoxFactoryApi get_task GET /factory/{task_id} GET /internal/factory/{task_id} – Get a single build task.
FoxFactoryApi list_tasks GET /factory GET /internal/factory – List build tasks.
FoxFactoryApi update_task PATCH /factory/{task_id} PATCH /internal/factory/{task_id} – Update task status / logs.
FoxFactoryApi update_worker_status POST /factory/update_status POST /internal/factory/update_status – Worker heartbeat / status update.
FoxFactoryApi upload_artifact POST /factory/{task_id}/artifact POST /internal/factory/{task_id}/artifact – Upload a build artifact.
GitlabApi add_gitlab_repo POST /gitlab/device/{device_id}/gitlab POST /gitlab/device/{device_id}/gitlab?gl_project_url=<url>
InternalApi change_password POST /profile/change_password POST /profile/change_password - Change the authenticated user's password.
InternalApi create_device POST /internal/devices POST /internal/devices/ - Create a new device.
InternalApi create_device_page POST /internal/wiki/device/{device_id}/page POST /internal/wiki/device/{device_id}/page - Create this device's page.
InternalApi create_page POST /internal/wiki/{site}/pages POST /internal/wiki/{site}/pages - Create a page.
InternalApi create_site POST /internal/wiki/sites POST /internal/wiki/sites - Create a site.
InternalApi delete_asset DELETE /internal/wiki/{site}/assets/{asset_id} DELETE /internal/wiki/{site}/assets/{asset_id} - Delete an asset.
InternalApi delete_device DELETE /internal/devices/{device_id} DELETE /internal/devices/{device_id} - Delete a device (only if no releases exist).
InternalApi delete_page DELETE /internal/wiki/{site}/pages/{path} DELETE /internal/wiki/{site}/pages/{path} - Delete a page and its history.
InternalApi delete_passkey DELETE /profile/passkeys/{credential_id} DELETE /profile/passkeys/{credential_id} - Revoke a passkey credential (requires password).
InternalApi delete_paste DELETE /internal/paste/{paste_id} DELETE /internal/paste/{paste_id} - Delete a paste (admin only).
InternalApi delete_release DELETE /internal/releases/{release_id} DELETE /internal/releases/{release_id} - Delete a release.
InternalApi delete_site DELETE /internal/wiki/sites/{site_id} DELETE /internal/wiki/sites/{site_id} - Delete a site and everything in it.
InternalApi delete_user DELETE /internal/users/{user_id} DELETE /internal/users/{user_id} - Delete a user.
InternalApi edit_device PUT /internal/devices/{device_id} PUT /internal/devices/{device_id} - Update a device.
InternalApi edit_release PUT /internal/releases/{release_id} PUT /internal/releases/{release_id} - Edit a release.
InternalApi edit_user PUT /internal/users/{user_id} PUT /internal/users/{user_id} - Update a user (admin only).
InternalApi get_device_info GET /internal/devices/{device_id} GET /internal/devices/{device_id} - Get device with stats.
InternalApi get_page GET /internal/wiki/{site}/pages/{path} GET /internal/wiki/{site}/pages/{path} - Fetch a page, draft or not.
InternalApi get_release_info GET /internal/releases/{release_id} GET /internal/releases/{release_id} - Get release with stats and maintainer info.
InternalApi get_revision GET /internal/wiki/revisions/{revision_id} GET /internal/wiki/revisions/{revision_id} - One revision, with its body.
InternalApi get_user GET /internal/users/{user_id} GET /internal/users/{user_id} - Get user with maintained devices.
InternalApi list_assets GET /internal/wiki/{site}/assets GET /internal/wiki/{site}/assets - List asset metadata.
InternalApi list_logs GET /internal/logs GET /internal/logs/ - Get paginated audit logs.
InternalApi list_pages GET /internal/wiki/{site}/pages GET /internal/wiki/{site}/pages - List pages, drafts included.
InternalApi list_passkeys GET /profile/passkeys GET /profile/passkeys - List the authenticated user's passkey credentials.
InternalApi list_pastes GET /internal/paste GET /internal/paste/ - List all pastes (admin only).
InternalApi list_revisions GET /internal/wiki/{site}/revisions GET /internal/wiki/{site}/revisions?path= - A page's history.
InternalApi list_sites GET /internal/wiki/sites GET /internal/wiki/sites - List sites, including their maintainer settings.
InternalApi list_users GET /internal/users GET /internal/users/ - List all users (short response).
InternalApi login POST /auth/login POST /auth/login
InternalApi logout POST /auth/logout POST /auth/logout
InternalApi passkey_login_options POST /auth/passkeys/login/options POST /auth/passkeys/login/options
InternalApi passkey_login_verify POST /auth/passkeys/login/verify POST /auth/passkeys/login/verify
InternalApi passkey_register_options POST /auth/passkeys/register/options POST /auth/passkeys/register/options
InternalApi passkey_register_verify POST /auth/passkeys/register/verify POST /auth/passkeys/register/verify
InternalApi rename_passkey POST /profile/passkeys/{credential_id}/rename POST /profile/passkeys/{credential_id}/rename - Rename a passkey credential.
InternalApi renew POST /auth/renew POST /auth/renew
InternalApi restore_revision POST /internal/wiki/revisions/{revision_id}/restore POST /internal/wiki/revisions/{revision_id}/restore - Roll a page back.
InternalApi update_page PUT /internal/wiki/{site}/pages/{path} PUT /internal/wiki/{site}/pages/{path} - Edit or move a page.
InternalApi update_paste PUT /internal/paste/{paste_id} PUT /internal/paste/{paste_id} - Update paste content (admin only).
InternalApi update_site PUT /internal/wiki/sites/{site_id} PUT /internal/wiki/sites/{site_id} - Update a site.
InternalApi upload_asset POST /internal/wiki/{site}/assets POST /internal/wiki/{site}/assets - Upload an asset.
InternalApi upload_new_release POST /internal/releases POST /internal/releases/ - Upload a new release.
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 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.
UsbApi create_session POST /internal/usb/sessions POST /internal/usb/sessions - Create a remote USB bridge session.
UsbApi delete_session DELETE /internal/usb/sessions/{code} DELETE /internal/usb/sessions/{code} - Revoke a session.
UsbApi list_sessions GET /internal/usb/sessions GET /internal/usb/sessions - List the caller's active sessions.
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

Documentation For Authorization

Authentication schemes defined for the API:

bearer_auth

  • Type: Bearer authentication (JWT)

Author

admin@orangefox.tech

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for yacha from gravatar.com yacha

Credits

Author: OpenAPI Generator community

License

GPL-3.0-only

Requires

Python >=3.10

Tags

OpenAPI OpenAPI-Generator Fox API

Metadata

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for yacha from gravatar.com yacha

Credits

Author: OpenAPI Generator community

License

GPL-3.0-only

Requires

Python >=3.10

Tags

OpenAPI OpenAPI-Generator Fox API

Release files for foxinternalclient 6.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxinternalclient 6.1.1
File Size Uploaded Provenance
foxinternalclient-6.1.1.tar.gz 93.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for foxinternalclient 6.1.1
File Interpreter ABI Platform
foxinternalclient-6.1.1-py3-none-any.whl 205.6 kB Without provenance Python 3 none any Details

Total release size: 299.5 kB

Release files / foxinternalclient-6.1.1.tar.gz

Download URL foxinternalclient-6.1.1.tar.gz
Size 93.9 kB
Tags Source
SHA-256 checksum
How to use checksums 		948e1cc758d508c55b63afc80477c1607a3eb82ea573e995538598a534cfd716
BLAKE2b-256 checksum
How to use checksums 		4b2cf5ec6abdd5e0b604c8dbd58c5d750c7961e326dad2b6a980904d1df66725
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via poetry/2.4.3 CPython/3.13.14 Linux/7.2.2-1-default

Release files / foxinternalclient-6.1.1-py3-none-any.whl

Download URL foxinternalclient-6.1.1-py3-none-any.whl
Size 205.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		d3b8167774488bfd5d73d2a71e90f3f8cf4688cc747fe129749a461757c52dc3
BLAKE2b-256 checksum
How to use checksums 		dc37bc4b6448229f1748e12bb8725cb6c68c15bf06ae8d19dbca81c567eaaa10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via poetry/2.4.3 CPython/3.13.14 Linux/7.2.2-1-default

Security for foxinternalclient 6.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page