GET /foreman_puppet/api/environments
List all environments

GET /foreman_puppet/api/puppetclasses/:puppetclass_id/environments
List environments of Puppet class

GET /foreman_puppet/api/locations/:location_id/environments
List environments per location

GET /foreman_puppet/api/organizations/:organization_id/environments
List environments per organization

Params

Param name Description
puppetclass_id
optional

ID of Puppet class

Validations:

  • Must be a String

location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

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$/.

Search fields

Field name Type Possible values
location
location_id
name
organization
organization_id

GET /foreman_puppet/api/environments/:id
Show an 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.


POST /foreman_puppet/api/environments
Create an environment

Params

Param name Description
environment
required

Validations:

  • Must be a Hash

environment[name]
required

Validations:

  • Must be a String

environment[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

environment[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


PUT /foreman_puppet/api/environments/:id
Update an 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.

environment
required

Validations:

  • Must be a Hash

environment[name]
optional

Validations:

  • Must be a String

environment[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

environment[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type


DELETE /foreman_puppet/api/environments/:id
Delete an 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.