POST /api/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy.

POST /api/smart_proxies/:smart_proxy_id/environments/:id/import_puppetclasses
Import puppet classes from puppet proxy for an environment

POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet proxy for 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.

smart_proxy_id
Optional

Validations:

  • Must be String

environment_id
Optional

Validations:

  • Must be String

dryrun
Optional

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

except
Optional

Optional comma-delimited string containing either 'new', 'updated', or 'obsolete' that is used to limit the imported Puppet classes

Validations:

  • Must be String


GET /api/environments
List all environments

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

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

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

Params

Param Name Description
puppetclass_id
Optional

ID of Puppet class

Validations:

  • Must be String

search
Optional

filter results

Validations:

  • Must be String

order
Optional

sort results

Validations:

  • Must be String

page
Optional

paginate results

Validations:

  • Must be String

per_page
Optional

number of entries per request

Validations:

  • Must be String


GET /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 /api/environments
Create an environment

Params

Param Name Description
environment
Required

Validations:

  • Must be a Hash

environment[name]
Required

Validations:

  • Must be String


PUT /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 String


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