GET /salt/api/salt_minions
List all Salt Minions

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort and order by a searchable field, e.g. 'id DESC'

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.


GET /salt/api/salt_minions/:id
Show a minion

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /salt/api/salt_minions/:id
Update a minion

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

minion
required

Validations:

  • Must be a Hash

minion[salt_environment_id]
optional , nil allowed

Salt environment ID

Validations:

  • Must be a number.

minion[salt_proxy_id]
optional , nil allowed

ID of Salt Proxy

Validations:

  • Must be a number.

minion[salt_state_ids]
optional , nil allowed

Array of State ids

Validations:

  • Must be an array of any type