GET /salt/api/salt_states
List all Salt states

Params

Param name Description
salt_environment_id
optional

Limit to a specific environment


Value:

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

search
optional

filter results


Value:

Must be String

order
optional

sort results


Value:

Must be String

page
optional

paginate results


Value:

Must be String

per_page
optional

number of entries per request


Value:

Must be String


GET /salt/api/salt_states/:id
Show a state

Params

Param name Description
id
required

Value:

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


POST /salt/api/salt_states
Create a state

Params

Param name Description
state
required

Value:

Must be a Hash

state[name]
required

Name of the Salt state


Value:

Must be String


DELETE /salt/api/salt_states/:id
Destroy a state

Params

Param name Description
id
required

Value:

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


POST /salt/api/salt_states/import/:smart_proxy_id
Import states from a salt master

Params

Param name Description
smart_proxy_id
required

Salt Smart Proxy ID


Value:

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

salt_environments
optional

Limit to a specific environments


Value:

Must be an array of any type

actions
optional

Limit to specific actions: i.e. add, remove


Value:

Must be an array of any type

dryrun
optional

Dryrun only


Value:

Must be 'true' or 'false'