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可

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

Validations:

  • Must be an array of any type

job_template[organization_ids]
任意 , nil可

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

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可

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

Validations:

  • Must be an array of any type

job_template[organization_ids]
任意 , nil可

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

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