SALT-API(1)

πŸŽ€ SALT-API(1) β€” ok bestie, it's the salt-api manual, welcome πŸ’–

So this is the manual page for salt-api, from the Salt docs, and honestly? She's serving remote-connection realness. Let's get into it. πŸ¦‹


✨ NAME ✨

salt-api β€” the salt-api Command πŸ’…

She starts up the interfaces you use to remotely connect to the salt master. That's the whole job. Iconic of her, honestly.


🌸 SYNOPSIS 🌸

salt-api

That's it. No args required. She just goes. πŸ‘‘


πŸ’œ DESCRIPTION πŸ’œ

Okay so the Salt API system is the girl who manages all the network api connectors for the Salt Master. That's literally her whole thing. She's the connector-wrangler. The network-api babysitter. No cap. 🫢


🧚 OPTIONS 🧚

Every flag, every detail, no skips. Let's go. πŸ’–

  • --version β€” prints the version of Salt that's running. Simple. Slay.
  • --versions-report β€” shows you the program's dependencies and its version number, and then dips out (exits). ✨
  • -h, --help β€” shows the help message and exits. When in doubt, bestie, ask for help. 🌈
  • -c CONFIG_DIR, --config-dir=CONFIG_dir β€” tells her where the Salt configuration directory lives. That directory holds the config files for the Salt master <italic>and</italic> the minions. On most systems the default location is /etc/salt. πŸ“
  • -d, --daemon β€” run salt-api as a daemon. She's independent now. She doesn't need you hovering. πŸ’…
  • --pid-file=PIDFILE β€” specify where the pidfile goes. Default: /var/run/salt-api.pid. πŸ“

πŸ’œ Logging Options πŸ’œ

These are the logging options, and they override any settings you defined in the configuration files. Yes, override. She said my rules now. 😌

  • -l LOG_LEVEL, --log-level=LOG_LEVEL β€” the console logging log level. Pick one of: all, garbage, trace, debug, info, warning, error, quiet. Default: warning. πŸ”₯
  • --log-file=LOG_FILE β€” the log file path. Default: /var/log/salt/api. πŸ“
  • --log-file-level=LOG_LEVEL_LOGFILE β€” the logfile logging log level. Same menu as above: one of all, garbage, trace, debug, info, warning, error, quiet. Default: warning. ⭐

πŸ‘€ SEE ALSO πŸ‘€

Go read these too, bestie, they're part of the lore:


🫢 AUTHOR 🫢

Thomas S. Hatch <thatch45@gmail.com> and a whole bunch of others β€” please see the Authors file for the full squad. πŸ’–


2025


πŸŽ€ periodt. that's the whole page. go start some api connectors bestie. πŸ’…

Version 3007.8 πŸ’– generated on September 18, 2025 at 06:58:52 UTC β€” so yeah, this manual was born on a Thursday, and she's been serving ever since. βœ¨πŸ¦‹ bye bestie!! 🌸

πŸ“¦ where this page comes from