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

Params

Param Name Description
search
Optional

필터 결과

Validations:

  • Must be String

order
Optional

결과 정렬

Validations:

  • Must be String

page
Optional

페이지네이션 결과

Validations:

  • Must be String

per_page
Optional

요청 당 항목 수

Validations:

  • Must be String


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

Params

Param Name Description
template
Required

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

Params

Param Name Description
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.


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

Params

Param Name Description
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/job_templates
Create a job template

Params

Param Name Description
job_template
Required

Validations:

  • Must be a Hash

job_template[name]
Required

Template name

Validations:

  • Must be String

job_template[job_category]
Required

Job category

Validations:

  • Must be String

job_template[description_format]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_template[provider_type]
Required

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

job_template[locked]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

편집을 위한 템플릿의 잠금 여부

Validations:

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

job_template[ssh]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Params

Param Name Description
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.

job_template
Required

Validations:

  • Must be a Hash

job_template[name]
Optional

Template name

Validations:

  • Must be String

job_template[job_category]
Optional

Job category

Validations:

  • Must be String

job_template[description_format]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

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

job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

job_template[locked]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

편집을 위한 템플릿의 잠금 여부

Validations:

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

job_template[ssh]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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 , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

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

Params

Param Name Description
version
Optional

Template version

Validations:

  • Must be String


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

Params

Param Name Description
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/job_templates/:id/clone
Clone a provision template

Params

Param Name Description
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.

job_template
Required

Validations:

  • Must be a Hash

job_template[name]
Required

Template name

Validations:

  • Must be String