The System API

The System API

Alert
For security reasons, the API documentation is no longer served publicly by the application.


The on-premises installation of the Enterprise version of the Veracity Learning LRS includes a system-level API for creating an LRS, adding users, and more. 

To open the System API Keys page, in the upper-right, click the User button (your account name) to expand the context menu, then select the Admin option. On the Admin page, in the Admin Tools section, click Manage System API Keys. 


System API Documentation

View the System API documentation for details on the commands, parameters, and schema. This API works the same as the LRS-level API does, with the same conventions for POST, GET, PUT, and DELETE. 
Notes
While the terminology is similar, don't confuse the System API with the LRS-level API. The System API is for managing the entire installation, not an individual LRS. 




Drop Files to Attach

    • Related Articles

    • The LRS API

      For security reasons, the API documentation is no longer served publicly by the application. Our Veracity Learning LRS has many tools and features that you can use. While you can get to these features through the user interface, you can also automate ...

    • Bootstrapping

      Support for bootstrapping was added in version 1.16.6 To support deployments in CI-CD or other automated environments, Veracity Learning can read a configuration file on startup that will configure users, LRSs, api keys, and more. This allows you to ...

    • Configuration

      Setting Configuration Values These settings only apply to on-site installations. When using a hosted SaaS plan, Veracity will manage the settings for your deployment. Contact support if you require modifications to the settings on your hosted ...

    • Plugins

      Veracity Learning 1.6 and later support plugins! A plugin is a collection of JavaScript code that extends the system to add new capabilities or to change how the system works. Overview A plugin is a collection of JavaScript code that adds or changes ...

    • Advanced Search and Aggregation

      Veracity exposes a few extensions to our interfaces that allow you additional options for querying and analyzing data. Advanced Search Our query builder interface lets you filter on stacks of almost any property in the official xAPI specification, ...