flip_api.fl_services.get_status

Attributes

router

Functions

get_status_endpoint(request[, db, user_id])

Retrieve the status of all federated learning networks.

Module Contents

flip_api.fl_services.get_status.router
flip_api.fl_services.get_status.get_status_endpoint(request: fastapi.Request, db: sqlmodel.Session = Depends(get_session), user_id: uuid.UUID = Depends(verify_token))

Retrieve the status of all federated learning networks.

This endpoint fetches the status of all networks, including server and client statuses, and returns a list of INetStatus objects representing each network’s status.

Parameters:

  • request (Request) – FastAPI request object.

  • db (Session) – Database session.

  • user_id (UUID) – ID of the authenticated user.

Returns:

A list of INetStatus objects containing the status of each network.

Return type:

list[INetStatus]

Raises:

HTTPException – If there is an error while retrieving the net statuses.