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

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
default_template true, false
environment
hostgroup
kind
location
location_id
locked true, false
name
operatingsystem
organization
organization_id
snippet true, false
template
vendor

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

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/provisioning_templates
Maak een Uitroltemplate

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

provisioning_template
required

Validations:

  • Must be a Hash

provisioning_template[name]
required

template naam

Validations:

  • Must be a String

provisioning_template[description]
optional , nil allowed

Validations:

  • Must be a String

provisioning_template[template]
required

Validations:

  • Must be a String

provisioning_template[snippet]
optional , nil allowed

Validations:

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

provisioning_template[audit_comment]
optional , nil allowed

Validations:

  • Must be a String

provisioning_template[template_kind_id]
optional , nil allowed

niet relevant voor knipsel

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
optional , nil allowed

Array van template combinaties (hostgroup_id,environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
optional , nil allowed

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

Validations:

  • Must be an array of any type

provisioning_template[locked]
optional , nil allowed

Of de template wel of niet is gelocked voor bewerken

Validations:

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

provisioning_template[location_ids]
optional , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
optional , nil allowed

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

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

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 , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
optional , nil allowed

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type

options
optional

Validations:

  • Must be a Hash

options[force]
optional , nil allowed

use if you want update locked templates

Validations:

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

options[associate]
optional , nil allowed

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 , nil allowed

Beveilig geïmporteerde sjablonen (standaard uit)

Validations:

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

options[default]
optional , nil allowed

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

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.

provisioning_template
required

Validations:

  • Must be a Hash

provisioning_template[name]
optional

template naam

Validations:

  • Must be a String

provisioning_template[description]
optional , nil allowed

Validations:

  • Must be a String

provisioning_template[template]
optional

Validations:

  • Must be a String

provisioning_template[snippet]
optional , nil allowed

Validations:

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

provisioning_template[audit_comment]
optional , nil allowed

Validations:

  • Must be a String

provisioning_template[template_kind_id]
optional , nil allowed

niet relevant voor knipsel

Validations:

  • Must be a number.

provisioning_template[template_combinations_attributes]
optional , nil allowed

Array van template combinaties (hostgroup_id,environment_id)

Validations:

  • Must be an array of any type

provisioning_template[operatingsystem_ids]
optional , nil allowed

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

Validations:

  • Must be an array of any type

provisioning_template[locked]
optional , nil allowed

Of de template wel of niet is gelocked voor bewerken

Validations:

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

provisioning_template[location_ids]
optional , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type

provisioning_template[organization_ids]
optional , nil allowed

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

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

version
optional

template versie

Validations:

  • Must be a String


DELETE /api/provisioning_templates/:id
Verwijder een uitroltemplate

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/provisioning_templates/build_pxe_default
Bewerk de standaard PXE menu op alle geconfigureerde TFTP servers

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


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

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.

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

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.