Skip to content

10. API

Ludovic edited this page Aug 29, 2023 · 33 revisions

Repomanager exposes an API that allows performing certain actions from a client host:

  • Registering or unregistering a host with Repomanager
  • Sending general host information to Repomanager
  • Sending package information of a host to Repomanager
  • Retrieving the configuration of a host profile from Repomanager

API URL: https://FQDN/api/v2

Path Method Authentication JSON param(s) Description
/host/registering POST Api key
hostname (required)
ip (required)
Register host to Repomanager
/host/registering DELETE Host Id + token   Unregister host from Repomanager
/host/status PUT Host Id + token
hostname (optional)
os (optional)
os_version (optional)
os_family (optional)
type (=virtualization type) (optional)
kernel (optional)
arch (optional)
profile (optional)
env (optional)
agent_status (optional)
linupdate_version (optional)
reboot_required (optional)
Send host general informations to Repomanager
/host/packages/installed PUT Host Id + token installed_packages (required) Send list of installed packages to Repomanager
/host/packages/available PUT Host Id + token available_packages (required) Send list of available packages updates to Repomanager
/host/packages/event PUT Host Id + token events (required) Send packages event history to Repomanager
/profile GET Host Id + token   Retrieve all available profiles configuration
/profile/<PROFILE> GET Host Id + token   Retrieve profile's global configuration
/profile/<PROFILE>/excludes GET Host Id + token   Retrieve profile's package exclusion configuration
/profile/<PROFILE>/repos GET Host Id + token   Retrieve profile's repositories configuration