flip_api.fl_services.get_net_status

Attributes

router

Functions

get_net_status(net_name[, db, user_id])

Get the status of a net and its clients. A net consists of a central controller with a worker at each of the Trusts.

Module Contents

flip_api.fl_services.get_net_status.router
flip_api.fl_services.get_net_status.get_net_status(net_name: str, db: sqlmodel.Session = Depends(get_session), user_id: uuid.UUID = Depends(verify_token))

Get the status of a net and its clients. A net consists of a central controller with a worker at each of the Trusts.

Parameters:

  • net_name (str) – The name of the network to get status for.

  • db (Session) – Database session.

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

Returns:

Object containing the network name and status of connected clients.

Return type:

INetStatus

Raises:

  • HTTPException – If the net is not found, if there is no response from the FL API, or if there is an error

  • retrieving the net status. –