REST API Reference

KeyServer's web service exposes a REST API for accessing the objects on KeyServer. This API gives view and modify access to Computers, Policies, Products, and other objects. It also can be used to manage Maps, Reports, Actions, and other web-centric data and settings.

The REST API documentation provides information on the REST methods and resources for version 2 of the API (available in KeyServer version 7.4.1.0 and higher). The API should be used for basic querying of the data, and not for bulk or heavy-use data retrieval. There are currently other more efficient mechanisms for processes that require full data capture or continual bulk data access.

The easiest way to test the API is to use a program like curl, although for GET-based methods a browser will be sufficient. Tools like Postman are useful for more advanced API testing.

Documentation is available online: https://www.sassafras.com/hrl/ksp-api.html.