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

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

POST /api/environments/:environment_id/smart_proxies/:id/import_puppetclasses
Import puppet classes from puppet Capsule for an environment

Params

Param Name Description
id
Required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

smart_proxy_id
Optional

Validations:

  • String

environment_id
Optional

Validations:

  • String

dryrun
Optional

Validations:

  • boolean

except
Optional

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

Validations:

  • String


GET /api/smart_proxies
List all capsules

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Integer

organization_id
Optional

Scope by organisations

Validations:

  • Integer

search
Optional

filter results

Validations:

  • String

order
Optional

sort results

Validations:

  • String

page
Optional

paginate results

Validations:

  • String

per_page
Optional

number of entries per request

Validations:

  • String


GET /api/smart_proxies/:id
Show a capsule

Params

Param Name Description
id
Required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


POST /api/smart_proxies
Create a capsule

Params

Param Name Description
smart_proxy
Required

Validations:

  • Hash

smart_proxy[name]
Required

Validations:

  • String

smart_proxy[url]
Required

Validations:

  • String

smart_proxy[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

smart_proxy[organization_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


PUT /api/smart_proxies/:id
Update a capsule

Params

Param Name Description
id
Required

Validations:

  • String

smart_proxy
Required

Validations:

  • Hash

smart_proxy[name]
Optional

Validations:

  • String

smart_proxy[url]
Optional

Validations:

  • String

smart_proxy[location_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

smart_proxy[organization_ids]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

REPLACE organisations with given ids.

Validations:

  • Must be an array of any type


DELETE /api/smart_proxies/:id
Delete a capsule

Params

Param Name Description
id
Required

Validations:

  • String


PUT /api/smart_proxies/:id/refresh
Refresh capsule features

Params

Param Name Description
id
Required

Validations:

  • String