GET /api/job_templates
Список шаблонов заданий

GET /api/locations/:location_id/job_templates
Список шаблонов заданий по местоположению

GET /api/organizations/:organization_id/job_templates
Список шаблонов заданий по организациям

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

отсортировать результаты

Validations:

  • Must be a String

page
необязательно

постраничный вывод

Validations:

  • Must be a String

per_page
необязательно

количество записей на запрос

Validations:

  • Must be a String


POST /api/job_templates/import
Импорт шаблона из ERB

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

template
обязательно

ERB

Validations:

  • Must be a String

overwrite
необязательно

Перезаписать, если шаблон уже существует

Validations:

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


GET /api/job_templates/:id/export
Экспорт шаблона в ERB

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

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
Показать информацию о шаблоне

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

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
Создать шаблон задания

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

job_template
обязательно

Validations:

  • Must be a Hash

job_template[name]
обязательно

Имя шаблона

Validations:

  • Must be a String

job_template[job_category]
обязательно

Категория

Validations:

  • Must be a String

job_template[description_format]
необязательно , nil разрешен

Это шаблон для генерации описания. Для того чтобы добавить переменную, используйте синтаксис %{package}; категорию задания — %{job_category}; название шаблона — %{template_name}.

Validations:

  • Must be a String

job_template[template]
обязательно

Validations:

  • Must be a String

job_template[provider_type]
обязательно

Тип провайдера

Validations:

  • Must be one of: SSH.

job_template[snippet]
необязательно , nil разрешен

Validations:

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

job_template[audit_comment]
необязательно , nil разрешен

Validations:

  • Must be a String

job_template[locked]
необязательно , nil разрешен

Блокирование шаблона для редактирования

Validations:

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

job_template[ssh]
необязательно , nil разрешен

Параметры провайдера SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
необязательно , nil разрешен

Параметры действующего пользователя

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
необязательно , nil разрешен

Пользователь, от имени которого будет запускаться сценарий (по принципу sudo)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
необязательно , nil разрешен

Разрешает переопределение действующего пользователя из формы вызова.

Validations:

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

job_template[ssh][effective_user][current_user]
необязательно , nil разрешен

Разрешает текущему пользователю выступать в роли действующего пользователя

Validations:

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

job_template[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

job_template[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
Обновить шаблон задания

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

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
обязательно

Validations:

  • Must be a Hash

job_template[name]
необязательно

Имя шаблона

Validations:

  • Must be a String

job_template[job_category]
необязательно

Категория

Validations:

  • Must be a String

job_template[description_format]
необязательно , nil разрешен

Это шаблон для генерации описания. Для того чтобы добавить переменную, используйте синтаксис %{package}; категорию задания — %{job_category}; название шаблона — %{template_name}.

Validations:

  • Must be a String

job_template[template]
необязательно

Validations:

  • Must be a String

job_template[provider_type]
необязательно

Тип провайдера

Validations:

  • Must be one of: SSH.

job_template[snippet]
необязательно , nil разрешен

Validations:

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

job_template[audit_comment]
необязательно , nil разрешен

Validations:

  • Must be a String

job_template[locked]
необязательно , nil разрешен

Блокирование шаблона для редактирования

Validations:

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

job_template[ssh]
необязательно , nil разрешен

Параметры провайдера SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
необязательно , nil разрешен

Параметры действующего пользователя

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
необязательно , nil разрешен

Пользователь, от имени которого будет запускаться сценарий (по принципу sudo)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
необязательно , nil разрешен

Разрешает переопределение действующего пользователя из формы вызова.

Validations:

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

job_template[ssh][effective_user][current_user]
необязательно , nil разрешен

Разрешает текущему пользователю выступать в роли действующего пользователя

Validations:

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

job_template[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

job_template[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

version
необязательно

Версия шаблона

Validations:

  • Must be a String


DELETE /api/job_templates/:id
Удалить шаблон задания

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

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
Клонировать подготовительный шаблон

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

id
обязательно

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
обязательно

Validations:

  • Must be a Hash

job_template[name]
обязательно

Имя шаблона

Validations:

  • Must be a String