Skip to main content
POST
/
api
/
run
Run Command Route
curl --request POST \
  --url https://api.example.com/api/run \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "fun": "<string>",
  "target_type": "glob",
  "args": [],
  "kwargs": {}
}
'
{
  "jid": "<string>",
  "minions": [
    "<string>"
  ]
}

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
​
target
string
required
Required string length: 1 - 1024
​
fun
string
required
Required string length: 1 - 128
​
target_type
enum<string>
default:glob
Available options:
glob,
list,
pcre,
grain,
nodegroup,
compound
​
args
string[]
​
kwargs
Kwargs · object

Response

Successful Response

​
jid
string
required
​
minions
string[]
required