GET /api/smart_variables
Som alle smart variabelen op

GET /api/hosts/:host_id/smart_variables
Som alle smart variabelen op voor een specifieke host

GET /api/hostgroups/:hostgroup_id/smart_variables
Som alle smart variabelen op voor een specifieke host groep

GET /api/puppetclasses/:puppetclass_id/smart_variables
Som alle smart variabelen op voor een specifieke Puppet class

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer

host_id
Optional

Validations:

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

hostgroup_id
Optional

Validations:

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

puppetclass_id
Optional

Validations:

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

show_hidden
Optional

Bekijk verstopte waarden

Validations:

  • Must be one of: true, false, 1, 0

search
Optional

filter resultaten

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
Optional

Pagineer de resultaten

Validations:

  • Must be a String

per_page
Optional

Aantal items per aanvraag

Validations:

  • Must be a String

Search fields

Field name Type Possible values
avoid_duplicates true, false
key string
merge_default true, false
merge_overrides true, false
override true, false
parameter string
puppetclass string

GET /api/smart_variables/:id
Toon een smart variabele

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

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.

show_hidden
Optional

Bekijk verstopte waarden

Validations:

  • Must be one of: true, false, 1, 0


POST /api/smart_variables
Maak een smart variabele

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer

smart_variable
Required

Validations:

  • Must be a Hash

smart_variable[variable]
Required

Naam van een variabele

Validations:

  • Must be a String

smart_variable[puppetclass_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Puppet class ID

Validations:

  • Must be a number.

smart_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Standaard waarde van een variabele

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

smart_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Als aangezet dan wordt de parameter wordt hidden in de UI

Validations:

  • Must be one of: true, false, 1, 0

smart_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

De volgorde waarin waarden worden opgezocht

Validations:

  • Must be a String

smart_variable[description]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Beschrijving van een variabele

Validations:

  • Must be a String

smart_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Types van validatie waarden

Validations:

  • Must be one of: regexp, list.

smart_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Gebruikt om sommige waarden af te dwingen voor de parameterwaarden

Validations:

  • Must be a String

smart_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Types van variabelen

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

smart_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Voeg alle matching values samen (alleen array/hash types)

Validations:

  • Must be one of: true, false, 1, 0

smart_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Voeg een default value toe wanneer alle matching waarden worden samengevoegd

Validations:

  • Must be one of: true, false, 1, 0

smart_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Verwijder dubbele waarden (alleen array type)

Validations:

  • Must be one of: true, false, 1, 0


PUT /api/smart_variables/:id
Wijzig een smart variabele

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

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_variable
Required

Validations:

  • Must be a Hash

smart_variable[variable]
Optional

Naam van een variabele

Validations:

  • Must be a String

smart_variable[puppetclass_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Puppet class ID

Validations:

  • Must be a number.

smart_variable[default_value]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Standaard waarde van een variabele

Validations:

  • Must be one of types: string, boolean, integer, real, array, hash, yaml, json

smart_variable[hidden_value]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Als aangezet dan wordt de parameter wordt hidden in de UI

Validations:

  • Must be one of: true, false, 1, 0

smart_variable[override_value_order]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

De volgorde waarin waarden worden opgezocht

Validations:

  • Must be a String

smart_variable[description]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Beschrijving van een variabele

Validations:

  • Must be a String

smart_variable[validator_type]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Types van validatie waarden

Validations:

  • Must be one of: regexp, list.

smart_variable[validator_rule]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Gebruikt om sommige waarden af te dwingen voor de parameterwaarden

Validations:

  • Must be a String

smart_variable[variable_type]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Types van variabelen

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

smart_variable[merge_overrides]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Voeg alle matching values samen (alleen array/hash types)

Validations:

  • Must be one of: true, false, 1, 0

smart_variable[merge_default]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Voeg een default value toe wanneer alle matching waarden worden samengevoegd

Validations:

  • Must be one of: true, false, 1, 0

smart_variable[avoid_duplicates]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Verwijder dubbele waarden (alleen array type)

Validations:

  • Must be one of: true, false, 1, 0


DELETE /api/smart_variables/:id
Verwijder een smart variabele

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
Optional

Scope met organisaties

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.