GET /api/job_templates
Listar modelos de trabalho

GET /api/locations/:location_id/job_templates
Listar modelos de trabalho por localização

GET /api/organizations/:organization_id/job_templates
Listar modelos de trabalho por organização

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


POST /api/job_templates/import
Importar um modelo de trabalho do ERB

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

template
requerido

Modelo ERB

Validations:

  • Must be a String

overwrite
opcional

Sobrescrever modelo, caso ele já exista

Validations:

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


GET /api/job_templates/:id/export
Exportar um modelo de trabalho para o ERB

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

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
Exibir detalhes do modelo de trabalho

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

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
Criar um modelo de trabalho

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

job_template
requerido

Validations:

  • Must be a Hash

job_template[name]
requerido

Nome do modelo

Validations:

  • Must be a String

job_template[job_category]
requerido

Categoria de trabalho

Validations:

  • Must be a String

job_template[description_format]
opcional , nulo permitido

Este modelo é usado para gerar a descrição. Os valores de entrada podem ser usados com a sintaxe %{package}. Você pode incluir também a categoria de trabalho e o nome do modelo usando %{job_category} e %{template_name}.

Validations:

  • Must be a String

job_template[template]
requerido

Validations:

  • Must be a String

job_template[provider_type]
requerido

Tipo de provedor

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcional , nulo permitido

Validations:

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

job_template[audit_comment]
opcional , nulo permitido

Validations:

  • Must be a String

job_template[locked]
opcional , nulo permitido

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

Validations:

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

job_template[ssh]
opcional , nulo permitido

Opções específicas do provedor SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcional , nulo permitido

Opções do usuário efetivo

Validations:

  • Must be a Hash

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

O usuário que deve ser usado para executar o script (usando mecanismos do tipo sudo)

Validations:

  • Must be a String

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

Se deve ser permitida ou não a substituição do usuário efetivo do formulário de invocação.

Validations:

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

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

Se o login do usuário atual deve ser usado ou não como o usuário efetivo

Validations:

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

job_template[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

job_template[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
Atualizar um modelo de trabalho

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

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

Nome do modelo

Validations:

  • Must be a String

job_template[job_category]
opcional

Categoria de trabalho

Validations:

  • Must be a String

job_template[description_format]
opcional , nulo permitido

Este modelo é usado para gerar a descrição. Os valores de entrada podem ser usados com a sintaxe %{package}. Você pode incluir também a categoria de trabalho e o nome do modelo usando %{job_category} e %{template_name}.

Validations:

  • Must be a String

job_template[template]
opcional

Validations:

  • Must be a String

job_template[provider_type]
opcional

Tipo de provedor

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcional , nulo permitido

Validations:

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

job_template[audit_comment]
opcional , nulo permitido

Validations:

  • Must be a String

job_template[locked]
opcional , nulo permitido

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

Validations:

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

job_template[ssh]
opcional , nulo permitido

Opções específicas do provedor SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcional , nulo permitido

Opções do usuário efetivo

Validations:

  • Must be a Hash

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

O usuário que deve ser usado para executar o script (usando mecanismos do tipo sudo)

Validations:

  • Must be a String

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

Se deve ser permitida ou não a substituição do usuário efetivo do formulário de invocação.

Validations:

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

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

Se o login do usuário atual deve ser usado ou não como o usuário efetivo

Validations:

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

job_template[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

job_template[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

version
opcional

Versão do modelo

Validations:

  • Must be a String


DELETE /api/job_templates/:id
Remover um modelo de trabalho

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

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 modelo de provisionamento

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

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

Nome do modelo

Validations:

  • Must be a String