GET /api/job_templates
ジョブテンプレートを一覧表示

GET /api/locations/:location_id/job_templates
ロケーションごとのジョブテンプレートを一覧表示

GET /api/organizations/:organization_id/job_templates
組織ごとのジョブテンプレートを一覧表示

Params

Param Name Description
location_id
Optional

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
Optional

組織別のスコープ

Validations:

  • Must be a Integer

search
Optional

結果のフィルター

Validations:

  • Must be a String

order
Optional

結果のソート

Validations:

  • Must be a String

page
Optional

結果のページネーション

Validations:

  • Must be a String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be a String


POST /api/job_templates/import
ERB からジョブテンプレートをインポート

Params

Param Name Description
template
Required

テンプレート ERB

Validations:

  • Must be a String

overwrite
Optional

テンプレートがすでに存在する場合は上書きする

Validations:

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


GET /api/job_templates/:id/export
ジョブテンプレートを 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
ジョブテンプレートの詳細を表示

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
ジョブテンプレートを作成

Params

Param Name Description
job_template
Required

Validations:

  • Must be a Hash

job_template[name]
Required

テンプレート名

Validations:

  • Must be a String

job_template[job_category]
Required

ジョブカテゴリー

Validations:

  • Must be a String

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

このテンプレートは説明を生成するために使用されます。入力値は構文 %{package} を使用して使用できます。また、%{job_category} と %{template_name} を使用してジョブカテゴリーおよびテンプレート名を含めることもできます。

Validations:

  • Must be a String

job_template[template]
Required

Validations:

  • Must be a String

job_template[provider_type]
Required

プロバイダータイプ

Validations:

  • Must be one of: SSH.

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

Validations:

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

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

Validations:

  • Must be a String

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

テンプレートを編集用にロックするかどうか

Validations:

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

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

SSH プロバイダー固有オプション

Validations:

  • Must be a Hash

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

実効ユーザーオプション

Validations:

  • Must be a Hash

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

スクリプトを実行するために使用するユーザー (sudo と同様のメカニズムを使用)

Validations:

  • Must be a String

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

呼び出し形式から実効ユーザを上書きするのを許可するかどうか。

Validations:

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

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

現在のユーザーログインを実行ユーザーとして使用するかどうか

Validations:

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

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

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

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

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
ジョブテンプレートを更新

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

テンプレート名

Validations:

  • Must be a String

job_template[job_category]
Optional

ジョブカテゴリー

Validations:

  • Must be a String

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

このテンプレートは説明を生成するために使用されます。入力値は構文 %{package} を使用して使用できます。また、%{job_category} と %{template_name} を使用してジョブカテゴリーおよびテンプレート名を含めることもできます。

Validations:

  • Must be a String

job_template[template]
Optional

Validations:

  • Must be a String

job_template[provider_type]
Optional

プロバイダータイプ

Validations:

  • Must be one of: SSH.

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

Validations:

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

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

Validations:

  • Must be a String

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

テンプレートを編集用にロックするかどうか

Validations:

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

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

SSH プロバイダー固有オプション

Validations:

  • Must be a Hash

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

実効ユーザーオプション

Validations:

  • Must be a Hash

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

スクリプトを実行するために使用するユーザー (sudo と同様のメカニズムを使用)

Validations:

  • Must be a String

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

呼び出し形式から実効ユーザを上書きするのを許可するかどうか。

Validations:

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

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

現在のユーザーログインを実行ユーザーとして使用するかどうか

Validations:

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

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

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

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

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Params

Param Name Description
version
Optional

テンプレートのバージョン

Validations:

  • Must be a String


DELETE /api/job_templates/:id
ジョブテンプレートを削除

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
プロビジョンテンプレートのクローン

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

テンプレート名

Validations:

  • Must be a String