Firely Server Administration API

Besides the regular FHIR endpoint, Firely Server also exposes an Administration API. The endpoint for this is:

http(s)://<firely-server-endpoint>/administration

Functions

The following functions are available in the Administration API.

• Conformance Resources

• Subscriptions

• Re-indexing for new or changed SearchParameters

• Reset the database

• Preloading resources

• Terminology services

Configuration

You can Configure the Administration API, including restricting access to functions of the Administration API to specific ip addresses.

Database

The Administration API uses a database separately from the main ‘Firely Server Data’ database. Historically, SQL Server, MongoDB and Memory are supported as databases for the Administration API.
As of Firely Server (Vonk) version 0.7.1, SQLite is advised for this, and we have made that the default configuration. See Using SQLite on how to configure for this.