GET /api/job_templates
List job templates

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

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

Parâmentros

Nome parâmetro Descrição
search
opcional

filtrar resultados

Validations:

  • Must be String

order
opcional

ordenar resultados

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be String


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

Parâmentros

Nome parâmetro Descrição
template
requerido

Template ERB

Validations:

  • Must be String

overwrite
opcional

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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

Parâmentros

Nome parâmetro Descrição
id
requerido

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
Create a job template

Parâmentros

Nome parâmetro Descrição
job_template
requerido

Validations:

  • Must be a Hash

job_template[name]
requerido

Template name

Validations:

  • Must be String

job_template[job_category]
requerido

Job category

Validations:

  • Must be String

job_template[description_format]
opcional , nulo permitido

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

Validations:

  • Must be String

job_template[provider_type]
requerido

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcional , nulo permitido

Validations:

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

job_template[audit_comment]
opcional , nulo permitido

Validations:

  • Must be String

job_template[locked]
opcional , nulo permitido

Se deve ou não o template está bloqueado para edição

Validations:

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

job_template[ssh]
opcional , nulo permitido

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcional , nulo permitido

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
opcional , nulo permitido

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

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
opcional , nulo permitido

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]
opcional , nulo permitido

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
Update a job template

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

Validations:

  • Must be a Hash

job_template[name]
opcional

Template name

Validations:

  • Must be String

job_template[job_category]
opcional

Job category

Validations:

  • Must be String

job_template[description_format]
opcional , nulo permitido

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

Validations:

  • Must be String

job_template[provider_type]
opcional

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcional , nulo permitido

Validations:

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

job_template[audit_comment]
opcional , nulo permitido

Validations:

  • Must be String

job_template[locked]
opcional , nulo permitido

Se deve ou não o template está bloqueado para edição

Validations:

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

job_template[ssh]
opcional , nulo permitido

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcional , nulo permitido

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
opcional , nulo permitido

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

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
opcional , nulo permitido

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]
opcional , nulo permitido

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

Parâmentros

Nome parâmetro Descrição
version
opcional

Template version

Validations:

  • Must be String


DELETE /api/job_templates/:id
Delete a job template

Parâmentros

Nome parâmetro Descrição
id
requerido

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
Clonar um template de provisão

Parâmentros

Nome parâmetro Descrição
id
requerido

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
requerido

Validations:

  • Must be a Hash

job_template[name]
requerido

Template name

Validations:

  • Must be String