salt-api

salt-api is a modular interface on top of Salt that can provide a variety of entry points into a running Salt system. It can start and manage multiple interfaces allowing a REST API to coexist with XMLRPC or even a Websocket API.

Getting started

Running salt-api will automatically start any netapi modules that have been configured in your Salt master config file. Consult the documentation for each netapi module for what options are required. salt-api must be run on the same machine as your Salt master.

netapi modules

The core functionality for salt-api lies in pluggable netapi modules that adhere to the simple interface of binding to a port and starting a service.

• Introduction to netapi modules
• Writing netapi modules

Full list of netapi modules

• Full list of netapi modules
  • rest_cherrypy

Releases

• Release notes

Reference

• Index
• Module Index
• Search Page
• glossary