Permissions

Learn how API key permissions work in the FUTO Home API


Every API key is created with a list of permissions. A request made with the key can only reach endpoints those permissions grant. all grants every permission. Session tokens are not scoped and act with the signed in user's full access.

Available permissions

Pass these values in permissions when you create an API key.

allapiKey.createapiKey.readapiKey.updateapiKey.deleteauth.changePasswordauthDevice.deletesession.createsession.readsession.updatesession.deletesystemMetadata.readsystemMetadata.updateuser.readuser.updateserver.aboutlinkedDevice.readlinkedDevice.createlinkedDevice.deleteaudio.readaudio.manageapp.readapp.installinternalEntry.readinternalEntry.scaninternalEntry.uploadinternalEntry.createinternalEntry.updateinternalEntry.deleteexternalMount.readexternalMount.createexternalMount.updateexternalMount.deleteexternalEntry.readexternalEntry.createexternalEntry.updateexternalEntry.deletesearch.readfile.readfile.createfile.updatefile.deletecast.readcast.controlupdates.readupdates.applyupdates.settingssystem.readsystem.powersystem.sshadminUser.createadminUser.readadminUser.updateadminUser.delete