salt-api

Warning

Outdated documentation

The salt-api project has been merged into the main Salt repository as of Salt's Helium release.

No api changes were made. The salt-api daemon remains intact and is now available in the default salt-master install.

The documentation has been moved into the main salt project as well. netapi module documentation is available in the module index.

No further development will take place in this repository. It will be left in the current state for historical purposes. Open issues will be migrated to the Salt repository.

Current documentation now lives within the main Salt documentation.

The documentation for the final salt-api release, 0.8.4.1, is included below.


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

  1. Install salt-api on the same machine as your Salt master.
  2. Edit your Salt master config file for all required options for each netapi module you wish to run.
  3. Install any required additional libraries or software for each netapi module you wish to run.
  4. Run salt-api which will then start all configured netapi modules.

Note

Each netapi module will have differing configuration requirements and differing required software libraries.

Exactly like the various module types in Salt (execution modules, renderer modules, returner modules, etc.), netapi modules in salt-api will not be loaded into memory or started if all requirements are not met.

Installation quickstart

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. salt-api can manage one or many services concurrently.

Reference