Config templates

>>>

GET /api/config_templates
Geef uitroltemplates weer

GET /api/operatingsystems/:operatingsystem_id/config_templates
Bekijk uitrol templates per besturingssysteem

GET /api/locations/:location_id/config_templates
Bekijk uitrol templates per locatie

GET /api/organizations/:organization_id/config_templates
Bekijk uitrol templates per organisatie

Params

Param Name Description
operatingsystem_id
Optional

ID van het besturingssysteem

Validations:

  • Must be a String
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer
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
default true, false
environment string
hostgroup string
kind string
location string
location_id integer
locked true, false
name string
operatingsystem string
organization string
organization_id integer
snippet true, false
template text
vendor string
>>>

GET /api/config_templates/:id
Geef uitrol template details weer

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

POST /api/config_templates
Maak een Uitroltemplate

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

Validations:

  • Must be a Hash
config_template[name]
Required

template naam

Validations:

  • Must be a String
config_template[template]
Required

Validations:

  • Must be a String
config_template[snippet]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0.
config_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
config_template[template_kind_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

niet relevant voor knipsel

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Array van template combinaties (hostgroup_id,environment_id)

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Array van besturingssysteem ID's om te associeren met de template

Validations:

  • Must be an array of any type
config_template[locked]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Of de template wel of niet is gelocked voor bewerken

Validations:

  • Must be one of: true, false, 1, 0.
config_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type
config_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type
>>>

PUT /api/config_templates/:id
Werk een uitroltemplate bij

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.
config_template
Required

Validations:

  • Must be a Hash
config_template[name]
Optional

template naam

Validations:

  • Must be a String
config_template[template]
Optional

Validations:

  • Must be a String
config_template[snippet]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be one of: true, false, 1, 0.
config_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String
config_template[template_kind_id]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

niet relevant voor knipsel

Validations:

  • Must be a number.
config_template[template_combinations_attributes]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Array van template combinaties (hostgroup_id,environment_id)

Validations:

  • Must be an array of any type
config_template[operatingsystem_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Array van besturingssysteem ID's om te associeren met de template

Validations:

  • Must be an array of any type
config_template[locked]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Of de template wel of niet is gelocked voor bewerken

Validations:

  • Must be one of: true, false, 1, 0.
config_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type
config_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: nl-NL.apipie.nil_allowed">Nil Allowed</span>

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type
>>>

GET /api/config_templates/revision

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
version
Optional

template versie

Validations:

  • Must be a String
>>>

DELETE /api/config_templates/:id
Verwijder een uitroltemplate

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

POST /api/config_templates/build_pxe_default
Bewerk de standaard PXE menu op alle geconfigureerde TFTP servers

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

POST /api/config_templates/:id/clone
Kloon een provisioning template

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.
config_template
Required

Validations:

  • Must be a Hash
config_template[name]
Required

template naam

Validations:

  • Must be a String