Smart proxies

>>>

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

Examples

POST /api/smart_proxies/182953976/import_puppetclasses
{
  "smart_proxy": {}
}
200
{
  "message": "Successfully updated environment and puppetclasses from the on-disk puppet installation",
  "environments_with_new_puppetclasses": 0,
  "environments_updated_puppetclasses": 1,
  "environments_obsolete": 1,
  "environments_ignored": 1,
  "results": [
    {
      "name": "env1",
      "actions": [
        "ignored"
      ],
      "ignored_environment": "env1"
    },
    {
      "name": "env2",
      "actions": [
        "updated",
        "obsolete"
      ],
      "updated_puppetclasses": [
        "a"
      ],
      "obsolete_puppetclasses": [
        "b",
        "c"
      ]
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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 a String
environment_id
optional

Validations:

  • Must be a String
dryrun
optional

Validations:

  • Must be one of: true, false, 1, 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 a String
>>>

GET /api/smart_proxies
List all smart proxies

Params

Param name Description
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 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$/.

Search fields

Field name Type Possible values
feature string
location string
location_id integer
name string
organization string
organization_id integer
url string
>>>

GET /api/smart_proxies/:id
Show a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
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/smart_proxies
Create a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
smart_proxy
required

Validations:

  • Must be a Hash
smart_proxy[name]
required

Validations:

  • Must be a String
smart_proxy[url]
required

Validations:

  • Must be a String
smart_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
smart_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

PUT /api/smart_proxies/:id
Update a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
smart_proxy
required

Validations:

  • Must be a Hash
smart_proxy[name]
optional

Validations:

  • Must be a String
smart_proxy[url]
optional

Validations:

  • Must be a String
smart_proxy[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
smart_proxy[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

DELETE /api/smart_proxies/:id
Delete a smart proxy

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
>>>

PUT /api/smart_proxies/:id/refresh
Refresh smart proxy features

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String