LiquidFiles Documentation
LiquidFiles Documentation

Introduction to the Admin API

The LiquidFiles Admin API will enable to you administer your LiquidFiles installation from outside the LiquidFiles web interface. The Admin interface is primarily a REST based API using JSON formatting.

For basic authentication and access description, please see the API documentation here. The Admin API uses the same basic functionality.

When accessing the Admin functions, you authorize yourself with the API key you use to authenticate yourself with to the system. To administer the system, your users API key needs to have permission to access and do the changes. This is the same as through the web interface. So if you want to administer Users, you need to authenticate as either a User Admin, Admin, Domain Admin or Sysadmin with that users respective API key.

The examples in the the Admin API use JSON to display outputs and formatting and all Admin API's only support JSON.