GET /api/provisioning_templates
Geef uitroltemplates weer

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

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

GET /api/organizations/:organization_id/provisioning_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/provisioning_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/provisioning_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

provisioning_template
Required

Validations:

  • Must be a Hash

provisioning_template[name]
Required

template naam

Validations:

  • Must be a String

provisioning_template[template]
Required

Validations:

  • Must be a String

provisioning_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

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

Validations:

  • Must be a String

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

provisioning_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

provisioning_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

provisioning_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

provisioning_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

provisioning_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


POST /api/provisioning_templates/import
Import a 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

provisioning_template
Required

Validations:

  • Must be a Hash

provisioning_template[name]
Optional

template naam

Validations:

  • Must be a String

provisioning_template[template]
Optional

template contents including metadata

Validations:

  • Must be a String

provisioning_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

provisioning_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

options
Optional

Validations:

  • Must be a Hash

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

use if you want update locked templates

Validations:

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

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

determines when the template should associate objects based on metadata, new means only when new template is being created, always means both for new and existing template which is only being updated, never ignores metadata

Validations:

  • Must be one of: new, always, never.

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

lock imported templates (false by default)

Validations:

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

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

makes the template default meaning it will be automatically associated with newly created organizations and locations (false by default)

Validations:

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


PUT /api/provisioning_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.

provisioning_template
Required

Validations:

  • Must be a Hash

provisioning_template[name]
Optional

template naam

Validations:

  • Must be a String

provisioning_template[template]
Optional

Validations:

  • Must be a String

provisioning_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

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

Validations:

  • Must be a String

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

provisioning_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

provisioning_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

provisioning_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

provisioning_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

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

provisioning_template
Required

Validations:

  • Must be a Hash

provisioning_template[name]
Required

template naam

Validations:

  • Must be a String


GET /api/provisioning_templates/:id/export
Exporteer een uitrol template naar ERB

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.