Config templates

>>>

GET /api/config_templates
Lista provisioneringsmallar

GET /api/operatingsystems/:operatingsystem_id/config_templates
Lista provisioneringsmallar per operativsystem

GET /api/locations/:location_id/config_templates
Lista provisioneringsmallar per plats

GET /api/organizations/:organization_id/config_templates
Lista provisioneringsmallar per organisation

Params

Param Name Description
operatingsystem_id
Optional

ID of operating system

Validations:

  • Must be a String
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
search
Optional

filtrera resultat

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

paginate results

Validations:

  • Must be a String
per_page
Optional

antal poster per begäran

Validations:

  • Must be a String

Search fields

Field name Typ 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
Visa detaljer för provisioneringsmall

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
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
Skapa en provisioneringsmall

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

Validations:

  • Must be a Hash
config_template[name]
Required

mallnamn

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: sv-SE.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: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

not relevant for snippet

Validations:

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

Array of template combinations (hostgroup_id, environment_id)

Validations:

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

Array of operating system IDs to associate with the template

Validations:

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

Whether or not the template is locked for editing

Validations:

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

REPLACE locations with given ids

Validations:

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

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

PUT /api/config_templates/:id
Uppdatera en provisioneringsmall

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

mallnamn

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: sv-SE.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: sv-SE.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

not relevant for snippet

Validations:

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

Array of template combinations (hostgroup_id, environment_id)

Validations:

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

Array of operating system IDs to associate with the template

Validations:

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

Whether or not the template is locked for editing

Validations:

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

REPLACE locations with given ids

Validations:

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

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
>>>

GET /api/config_templates/revision

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

mallversion

Validations:

  • Must be a String
>>>

DELETE /api/config_templates/:id
Radera en provisioneringsmall

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
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
Update the default PXE menu on all configured TFTP servers

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

POST /api/config_templates/:id/clone
Klona en provisioneringsmall

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

mallnamn

Validations:

  • Must be a String