REST API

This document explains which Coordinator and Aggregator API endpoints are available and how to use them.

Swagger UI

The docker-compose setup includes a Swagger UI container that can be used to view the Swagger files. After you have started docker-compose via the command docker-compose -f docker/docker-compose.yml up in the root of the repository, you can view the Swagger UI in your browser at the following address: http://127.0.0.1/.

Coordinator API Reference

GET /rendez_vous

Status Codes

• 200 OK – client accepted

• 404 Not Found –

GET /heartbeat/{client_id}

Parameters

• client_id (string) – ID of the client

Status Codes

• 200 OK – heartbeat confirmed

• 404 Not Found – client unknown

GET /start_training/{client_id}

Parameters

• client_id (string) – ID of the client

Status Codes

• 200 OK – get information for fetching the latest global model

• 404 Not Found –

Aggregator API Reference

GET /{client_id}/{client_token}

Parameters

• client_id (string) – ID of the client

• client_token (string) – API token of the client

Status Codes

• 200 OK – weights of the global model

• 404 Not Found – client unknown

POST /{client_id}/{client_token}

Parameters

• client_id (string) – ID of the client

• client_token (string) – API token of the client

Status Codes

• 200 OK – successful operation

• 404 Not Found – client unknown