vpn
VPN profiles: what administrators import and set, and the gateways of this node.
attributeadmin_router= APIRouter(prefix='/api/admin/vpn', dependencies=[Depends(verify_admin), Depends(routing.announce_changes)], route_class=EncryptedRoute)func_view(record) -> VpnProfileViewparamrecorddict[str, Any]Returns
app.models.VpnProfileViewfunclist_profiles() -> list[VpnProfileView]List the profiles, each with its gateways on this node.
Returns
list[app.models.VpnProfileView]funcimport_profiles(body=Depends(get_decrypted_request_body), user=Depends(verify_admin)) -> list[VpnProfileView]Make profiles of an uploaded config file or archive (see vpn.import_profiles).
parambodydict[str, Any]= Depends(get_decrypted_request_body)paramuserdict[str, Any]= Depends(verify_admin)Returns
list[app.models.VpnProfileView]funcupdate_profile(profile_id, body=Depends(get_decrypted_request_body)) -> VpnProfileViewChange a profile's name, published endpoints, cap, access, labels, or credentials.
paramprofile_idstrparambodydict[str, Any]= Depends(get_decrypted_request_body)Returns
app.models.VpnProfileViewfuncadd_endpoints(profile_id, body=Depends(get_decrypted_request_body), user=Depends(verify_admin)) -> VpnProfileViewAdd the endpoints of an uploaded config file or archive to a profile.
paramprofile_idstrparambodydict[str, Any]= Depends(get_decrypted_request_body)paramuserdict[str, Any]= Depends(verify_admin)Returns
app.models.VpnProfileViewfuncdelete_profile(profile_id) -> ResponseDelete a profile; its gateways stay up until the sessions using them end.
paramprofile_idstrReturns
fastapi.Response