Skip to main content
PUT
/
api
/
admin
/
settings
/
salt
Put Salt Route
curl --request PUT \
  --url https://api.example.com/api/admin/settings/salt \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "username": "<string>",
  "password": "<string>",
  "verify": true
}
'
{
  "salt": {
    "url": "<string>",
    "username": "<string>",
    "password_set": true,
    "verify": true
  },
  "pollers": {
    "inventory_refresh_minutes": 123,
    "inventory_refresh_initial_delay_s": 123,
    "fleet_poll_interval_seconds": 123,
    "jobs_poll_interval_seconds": 123,
    "minion_state_keys_interval_seconds": 123,
    "minion_state_presence_interval_seconds": 123,
    "minion_state_grains_interval_seconds": 123,
    "minion_state_initial_delay_seconds": 123,
    "event_stream_enabled": true,
    "event_stream_retention_days": 123
  },
  "widget": {
    "widget_hide_dispatch": true,
    "widget_hide_routine": true,
    "widget_show_jobs": true,
    "widget_show_keys": true,
    "widget_show_minions": true,
    "widget_event_count": 123,
    "widget_heartbeat_minutes": 123
  },
  "logging": {},
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://www.halite-app.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

PUT body for the salt section. All fields optional — only the ones present are applied. At least one must be present.

url
string<uri> | null
Required string length: 1 - 2083
username
string | null
Maximum string length: 255
password
string<password> | null
verify
boolean | null
eauth
enum<string> | null
Available options:
pam,
sharedsecret,
ldap,
file,
auto

Response

Successful Response

salt
SaltSettingsOut · object
required

Salt API connection settings. Password is never returned — only a boolean password_set so the UI can render "(set)" without exposing the value.

pollers
PollerSettingsOut · object
required
widget
WidgetSettingsOut · object
required
logging
LoggingSettingsOut · object
required
updated_at
string<date-time>
required