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	výsledky filtru Validations: Must be a String
order Optional	Sort field and order, eg. ‘id DESC’ Validations: Must be a String
page Optional	Číslo stránky, začíná od jedničky Validations: Must be a number.
per_page Optional	Počet výsledků na stránku 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`.