GET /api/job_templates
Aufgabenvorlagen auflisten

GET /api/locations/:location_id/job_templates
List job templates per location

GET /api/organizations/:organization_id/job_templates
List job templates per organization

Parameter

Parametername Beschreibung
search
optional

Ergebnisse filtern

Validations:

  • Must be String

order
optional

Ergebnisse sortieren

Validations:

  • Must be String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be String


POST /api/job_templates/import
Import a job template from ERB

Parameter

Parametername Beschreibung
template
verpflichtend

Template ERB

Validations:

  • Must be String

overwrite
optional

Overwrite template if it already exists

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’


GET /api/job_templates/:id/export
Export a job template to ERB

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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


GET /api/job_templates/:id
Show job template details

Parameter

Parametername Beschreibung
id
verpflichtend

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/job_templates
Aufgabenvorlage erstellen

Parameter

Parametername Beschreibung
job_template
verpflichtend

Validations:

  • Must be a Hash

job_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be String

job_template[job_category]
verpflichtend

Aufgabenkategorie

Validations:

  • Must be String

job_template[description_format]
optional , nil erlaubt

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.

Validations:

  • Must be String

job_template[template]
verpflichtend

Validations:

  • Must be String

job_template[provider_type]
verpflichtend

Anbietertyp

Validations:

  • Must be one of: SSH.

job_template[snippet]
optional , nil erlaubt

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

job_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be String

job_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

job_template[ssh]
optional , nil erlaubt

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optional , nil erlaubt

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optional , nil erlaubt

What user should be used to run the script (using sudo-like mechanisms)

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
optional , nil erlaubt

Whether it should be allowed to override the effective user from the invocation form.

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

job_template[ssh][effective_user][current_user]
optional , nil erlaubt

Whether the current user login should be used as the effective user

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’


PUT /api/job_templates/:id
Aufgabenvorlage hochladen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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

job_template
verpflichtend

Validations:

  • Must be a Hash

job_template[name]
optional

Vorlagenname

Validations:

  • Must be String

job_template[job_category]
optional

Aufgabenkategorie

Validations:

  • Must be String

job_template[description_format]
optional , nil erlaubt

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.

Validations:

  • Must be String

job_template[template]
optional

Validations:

  • Must be String

job_template[provider_type]
optional

Anbietertyp

Validations:

  • Must be one of: SSH.

job_template[snippet]
optional , nil erlaubt

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

job_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be String

job_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

job_template[ssh]
optional , nil erlaubt

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optional , nil erlaubt

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optional , nil erlaubt

What user should be used to run the script (using sudo-like mechanisms)

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
optional , nil erlaubt

Whether it should be allowed to override the effective user from the invocation form.

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

job_template[ssh][effective_user][current_user]
optional , nil erlaubt

Whether the current user login should be used as the effective user

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’


GET /api/job_templates/revision

Parameter

Parametername Beschreibung
version
optional

Vorlagenversion

Validations:

  • Must be String


DELETE /api/job_templates/:id
Aufgabenvorlage löschen

Parameter

Parametername Beschreibung
id
verpflichtend

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/job_templates/:id/clone
Bereitstellungsvorlage klonen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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

job_template
verpflichtend

Validations:

  • Must be a Hash

job_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be String