For AI agents: visit https://docs.biot-med.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
BioT
User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's FreeBioT
API Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
User GuideAPI Reference

The BioT API

  • The BioT API - Getting Started

BioT User Management Service

  • User API
    • Generate a new password for a Userpost
    • Validate user credentialspost
    • Get User by IDget
    • Delete Userdel
    • Update Userpatch
    • Search User entities by filterget
  • Login API
    • Refresh JWT tokenpost
    • Login with refresh tokenpost
    • Login with OTPpost
    • Generate login OTPpost
    • Logoutpost
    • Login with credentialspost
  • Self User API
    • Self get userget
    • Self registration of Userpost
    • Self delete userdel
    • Self update userpatch
    • Send reset password messagepost
  • MFA Login API
    • MFA loginpost
    • Resend SMS for MFA verificationpost
  • Service User API
    • Search Service User entities by filterget
    • Create a new Service Userpost
    • Create a new Service Userpost
    • Service User Loginpost
    • Get Service User by IDget
    • Delete Service Userdel
    • Update Service Userpatch
    • Delete secret key of a service user by service user id and secret key iddel
  • Temporary Token Operation API
    • Validation token operationget
    • Execute token operationpost
    • Execute token operationget
  • Temporary Credentials API
    • Get MQTT temporary credentials for receiving notification for all entities in an organization.get
  • Security API
    • Get public keyget
  • Health Check API
    • Service Health check APIget

BioT Settings Service

  • Template API
    • Get Template by IDget
    • Update Templateput
    • Delete Templatedel
    • Search Template entities by filterget
    • Create a new Templatepost
    • Get template overviewget
    • Search Template entities by filterget
  • Plugin-V2 API
    • Search Plugin entities by filterget
    • Create a new Pluginpost
    • Get plugin by nameget
    • Delete Plugindel
    • Update Pluginpatch
    • Get temporary credentials for the docker repositoryget
  • Translation API
    • Validate translations for localepost
    • Update translations for localepatch
    • Download locale translation fileget
    • Search Locale translations overview entities by filterget
    • Delete all translations for localedel
  • System API
    • Get system propertiesget
  • Backup API
    • Backuppost
    • Search Restore entities by filterget
    • Search Backup entities by filterget
  • Locale API
    • Add locale to the available localespost
    • Get available locales, the default locale and the system localeget
    • Update available locales and/or the system default locale.patch
    • Remove a locale from the available localesdel
  • Export Import Configuration API
  • Code Snippet API
    • Create a new Code snippetpost
    • Get Code snippet by IDget
    • Delete Code snippetdel
  • Entity API
    • Get all Entity typesget
    • Get all notifiable actionsget
    • Get all Entity typesget
    • Get all notifiable actionsget
  • Interception Configuration API
    • Search Code snippet entities by filterget
    • Search Interception Configurations entities by filterget
  • Health Check API
    • Service Health check APIget

BioT Device Service

  • Device API
    • Search Device entities by filterget
    • Create a new Device by Template idpost
    • Create a new Device by Template namepost
    • Get Device by IDget
    • Delete Devicedel
    • Update Devicepatch
    • Get Device Connection Details by IDget
  • Device Certificate API
    • Create new Certificate for Devicepost
    • Delete Certificate for Devicedel
    • Activate Certificate for Devicepost
  • Temporary Token Operation API
    • Validation token operationget
    • Execute token operationpost
    • Execute token operationget
  • Usage Session API
    • Create a new Usage Session by Template idpost
    • Create a new Usage Session by Template namepost
    • Get Usage Session by IDget
    • Delete Usage Sessiondel
    • Update Usage Sessionpatch
    • Search Usage Session entities by filterget
    • Search currently in progress devices' sessions entities by filterget
    • Delete Usage Sessiondel
  • Usage Session Remote Control API
    • Stop an existing Usage Sessionpost
    • Resume a paused Usage Sessionpost
    • Pause an existing Usage Sessionpost
    • Create and start a Usage Sessionpost
  • Command API
    • Start a new command by namepost
    • Stop an existing Commandpost
    • Start a new commandpost
    • Get Command by IDget
    • Delete Commanddel
    • Search Command entities by filterget
  • Device Alert API
    • Create a new Device Alert by Template idpost
    • Create a new Device Alert by Template namepost
    • Get Device Alert by IDget
    • Delete Device Alertdel
    • Update Device Alertpatch
    • Search open device's alerts entities by filterget
    • Search Device Alert entities by filterget
  • Temporary Credentials API
    • Get mqtt temporary credentials for device gatewayget
    • Get mqtt temporary credentials for receiving device measurements for all devices in an organization.get
  • Endpoint API
    • Get endpointget
  • Health Check API
    • Service Health check APIget

BioT Dispatcher Service

  • Subscription API
    • Unsubscribe from notifications for actionspost
    • Subscribe to get notifications for actionspost
    • Search Subscription entities by filterget
  • Interception API
    • Unsubscribe a specific endpoint from intercepting API(s)post
    • Subscribe for intercepting APIspost
    • Search for active interception subscriptionsget
  • Health Check API
    • Service Health check APIget

BioT Data Management Service

  • Temporary Token Operation API
    • Validation token operationget
    • Execute token operationpost
    • Execute token operationget
  • Report API
    • Cancel Reportpost
    • Create a new Reportpost
    • Search Report entities by filterget
    • Get Report by IDget
    • Delete Reportdel
  • Analytics DB API
    • Stop Analytics DB Synchronizationpost
    • Stop Analytics DB Initializationpost
    • Start Analytics DB Initializationpost
    • Get Analytics DB Information by IDget
    • Get Analytics DB Connection Details by IDget
  • Analytics DB State API
    • Stop Analytics DB Synchronizationpost
    • Stop Analytics DB Initializationpost
    • Start Analytics DB Initializationpost
    • Get Analytics DB Stateget
  • Analytics DB Connection API
    • Get Analytics DB Connection Details by IDget
  • BI Dashboard API
  • Health Check API
    • Service Health check APIget

BioT Facade

  • Patient Sign Up API
    • Self sign up for patientspost
    • Anonymous self sign up for patientspost
    • Assign a device to a patientpost
  • Health Check API
    • Service Health check APIget

BioT Generic Entity Service

  • Generic Entity API
    • Search Generic Entity entities by filterget
    • Create a new Generic Entity by Template idpost
    • Create a new Generic Entity by Template namepost
    • Get Generic Entity by IDget
    • Delete Generic Entitydel
    • Update Generic Entitypatch
  • Health Check API
    • Service Health check APIget
  • Generic Entity API V3
    • Search Generic Entity entities by filterget
    • Create a new Generic Entity by Template namepost
    • Get Generic Entity by IDget
    • Delete Generic Entitydel
    • Update Generic Entitypatch

BioT Measurement Service

  • Measurements API
    • Save measurementpost
    • Save measurements in bulkpost
    • Get raw measurementsget
    • Get aggregated measurementsget
  • Measurements V2 API
    • Search Raw Measurements entities by filter (token-based pagination)get
    • Search Aggregated Measurements entities by filter (token-based pagination)get
  • Health Check API
    • Service Health check APIget

BioT Notification Service

  • Configuration API
    • Get service configurationget
    • Set service configurationput
    • Get is sms provider configuredget
  • SMS API
    • Send smspost
  • Email API
    • Send emailpost
    • Add attachmentpost
  • Health Check API
    • Service Health check APIget

BioT Organization Service

  • Landing Page API
    • Get landing pages by typeget
    • Set a landing pageput
    • Delete landing pages by typedel
  • Patient API
    • Search Patient entities by filterget
    • Create a new Patient by Template idpost
    • Enable or Disable Patient Userpost
    • Create a new Patient by Template namepost
    • Get Patient by IDget
    • Delete Patientdel
    • Update Patientpatch
    • Search available organizations for sign up entities by filterget
    • Get self Patient by ID from access tokenget
  • Patient Alert API
    • Create a new Patient Alert by Template idpost
    • Create a new Patient Alert by Template namepost
    • Get Patient Alert by IDget
    • Delete Patient Alertdel
    • Update Patient Alertpatch
    • Search open patient's alerts entities by filterget
    • Search Patient Alert entities by filterget
  • Organization User API
    • Search Organization User entities by filterget
    • Create a new Organization User by Template idpost
    • Enable or Disable Organization Userpost
    • Create a new Organization User by Template namepost
    • Get Organization User by IDget
    • Delete Organization Userdel
    • Update Organization Userpatch
    • Get self Organization User by ID from access tokenget
  • Caregiver API
    • Search Caregiver entities by filterget
    • Create a new Caregiver by Template idpost
    • Enable or Disable Caregiver Userpost
    • Create a new Caregiver by Template namepost
    • Get Caregiver by IDget
    • Delete Caregiverdel
    • Update Caregiverpatch
    • Get self Caregiver by ID from access tokenget
  • Temporary Token Operation API
    • Validation token operationget
    • Execute token operationpost
    • Execute token operationget
  • Registration Code API
    • Search Registration Code entities by filterget
    • Create a new Registration Code by Template idpost
    • Create a new Registration Code by Template namepost
    • Get Registration Code by IDget
    • Delete Registration Codedel
    • Update Registration Codepatch
  • Organization API
    • Search Organization entities by filterget
    • Create a new Organization by Template idpost
    • Create a new Organization by Template namepost
    • Update Organizationpost
    • Get Organization by IDget
    • Delete Organizationdel
    • Update Organizationpatch
  • Invitation API
    • Resend Invitation by IDpost
  • User API
    • Get self User by ID from access tokenget
  • Health Check API
    • Service Health check APIget
  • Generic Entity API
    • Search Generic Entity entities by filterget
    • Create a new Generic Entity by Template idpost
    • Create a new Generic Entity by Template namepost
    • Get Generic Entity by IDget
    • Delete Generic Entitydel
    • Update Generic Entitypatch
  • Device API
    • Search Device entities by filterget
    • Create a new Device by Template idpost
    • Create a new Device by Template namepost
    • Get Device by IDget
    • Delete Devicedel
    • Update Devicepatch
    • Get Device Connection Details by IDget
  • Device Certificate API
    • Create new Certificate for Devicepost
    • Delete Certificate for Devicedel
    • Activate Certificate for Devicepost
  • Usage Session API
    • Create a new Usage Session by Template idpost
    • Create a new Usage Session by Template namepost
    • Get Usage Session by IDget
    • Delete Usage Sessiondel
    • Update Usage Sessionpatch
    • Search Usage Session entities by filterget
    • Search currently in progress devices' sessions entities by filterget
    • Delete Usage Sessiondel
  • Usage Session Remote Control API
    • Stop an existing Usage Sessionpost
    • Resume a paused Usage Sessionpost
    • Pause an existing Usage Sessionpost
    • Create and start a Usage Sessionpost
  • Command API
    • Start a new command by namepost
    • Stop an existing Commandpost
    • Start a new commandpost
    • Get Command by IDget
    • Delete Commanddel
    • Search Command entities by filterget
  • Device Alert API
    • Create a new Device Alert by Template idpost
    • Create a new Device Alert by Template namepost
    • Get Device Alert by IDget
    • Delete Device Alertdel
    • Update Device Alertpatch
    • Search open device's alerts entities by filterget
    • Search Device Alert entities by filterget
  • Temporary Credentials API
    • Get mqtt temporary credentials for device gatewayget
    • Get mqtt temporary credentials for receiving device measurements for all devices in an organization.get
  • Endpoint API
    • Get endpointget

BioT File Service

  • Multiple Part File API
    • Upload ETags for parts of a multiple part file uploadput
    • Generate signed URLs for multiple part file uploadpost
    • Create a new Filepost
    • Complete multiple part file uploadpost
    • Cancel multiple part file uploaddel
  • File API
    • Create a new Filepost
    • Get File by IDget
  • Health Check API
    • Service Health check APIget

BioT Entity Service

  • Health Check API
    • Service Health check APIget
Powered by 

BI Dashboard API

Updated 10 months ago


Get Analytics DB Connection Details by ID
Health Check API
Did this page help you?

Updated 10 months ago


Get Analytics DB Connection Details by ID
Health Check API
Did this page help you?