GET /salt/api/salt_environments
List all Salt environments

Params

Param Name Description
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, 'all' to return all results

Validations:

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


GET /salt/api/salt_environments/:id
Show a Salt environment

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_environments
Create a Salt environment

Params

Param Name Description
environment
Required

Validations:

  • Must be a Hash

environment[name]
Required

Validations:

  • Must be a String


DELETE /salt/api/salt_environments/:id
Destroy a Salt environment

Params

Param Name Description
id
Required

Validations:

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