Skip to main content
POST
/
api
/
admin
/
settings
/
test-salt
Test Salt Route
curl --request POST \
  --url https://api.example.com/api/admin/settings/test-salt \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "username": "<string>",
  "password": "<string>",
  "verify": true
}
'
{
  "ok": true,
  "detail": "<string>",
  "minion_count": 123
}

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

POST body for the test-connection endpoint. All fields required.

​
url
string<uri>
required
Required string length: 1 - 2083
​
username
string
required
Required string length: 1 - 255
​
password
string<password>
required
write-only
​
verify
boolean
required
​
eauth
enum<string>
required
Available options:
pam,
sharedsecret,
ldap,
file,
auto

Response

Successful Response

​
ok
boolean
required
​
detail
string
required
​
minion_count
integer | null