Scaleout Edge REST API
======================

This section documents the server-side REST API exposed by the Scaleout Edge
control plane. These endpoints are used by clients, combiners, and external
integrations to interact with the Scaleout Edge network. The API includes
operations for project management, training orchestration, model handling,
metrics, telemetry, and system-level metadata.

Filtering
---------
Endpoints that return many records accept query parameters that filter the result.
Filter on one field with ``GET /clients?name=John``.
Combine fields with ``GET /clients?name=John&status=active``.

To match several values of the same field, send a ``POST`` to the ``list`` endpoint of the entity:

.. code-block:: text

   POST /clients/list
   {
     "name": ["John", "Doe"]
   }

To match records where a field is missing, use ``null`` as the value:

.. code-block:: text

   GET /clients?name=null

For numbers and dates, add a comparison operator to the field name, for example ``GET /clients?commit_time__gt=2023-01-01``.
The operators are:

* ``__gt``: greater than
* ``__lt``: less than
* ``__gte``: greater than or equal to
* ``__lte``: less than or equal to
* ``__ne``: not equal to
* ``__eq``: equal to

Authentication and Control
--------------------------
Endpoints related to authentication, authorization, and high-level control of the federated network.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: auth_routes.py, control_routes.py, attribute_routes.py

Clients and Combiners
---------------------
Endpoints for managing clients, combiners, and their runtime state in the federated network.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: client_routes.py, combiner_routes.py, status_routes.py

Sessions, Rounds, and Runs
--------------------------
Endpoints that control training sessions, orchestration rounds, and execution runs.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: session_routes.py, round_routes.py, run_routes.py

Models, Packages, and Model Tags
---------------------------------
Endpoints for handling model artifacts, compute packages, validation, and model tags.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: model_routes.py, package_routes.py, validation_routes.py, modeltag_routes.py

Metrics, Telemetry, and Helpers
-------------------------------
Endpoints for metrics, telemetry, and supporting helper operations.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: metric_routes.py, telemetry_routes.py, helper_routes.py

Large File Uploads
------------------
Endpoints for uploading large files using chunked uploads.

.. rest-api:: scaleout-core/scaleoutcore/network/api/v1
   :files: upload_routes.py