Interface ApiInterface

Main API interface which shall contain all sub API objects.


  • ApiInterface


legacyApi: IvionInterface


  • Checks whether the API feature is enabled for this instance. If not licensed the API can not be used and will throw errors if attempted. Therefore use this method to check first whether other API calls will work.

    Returns boolean

  • Whether private mode is on or not. If an instance is private, only logged in users will have access to data.

    Returns Promise<boolean>

Generated using TypeDoc