API documentation

>>>

GET /salt/api/salt_states
List all Salt states

Params

Param name	Description
salt_environment_id optional	Limit to a specific environment 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.
search optional	filter results Validations: Must be a String
order optional	Sort field and order, eg. ‘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 Validations: Must be a number.

>>>

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

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.

>>>

POST /salt/api/salt_states
Create a state

Params

Param name

Description

state
required

Validations:

Must be a Hash

state[name]
required

Name of the Salt state

Validations:

Must be a String

>>>

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

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.

>>>

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 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.
salt_environments optional	Limit to a specific environments Validations: Must be an array of any type
actions optional	Limit to specific actions: i.e. add, remove Validations: Must be an array of any type
dryrun optional	Dryrun only Validations: Must be one of: `true`, `false`, `1`, `0`.