Foreman considers a domain and a DNS zone as the same thing. That is, if you are planning to manage a site where all the machines are or the form hostname.somewhere.com then the domain is somewhere.com. This allows Foreman to associate a puppet variable with a domain/site and automatically append this variable to all external node requests made by machines at that site.


GET /api/domains
ドメイン一覧

GET /api/subnets/:subnet_id/domains
サブネットごとのドメインの一覧

GET /api/locations/:location_id/domains
ロケーションごとのドメインの一覧

GET /api/organizations/:organization_id/domains
組織ごとのドメインの一覧

Params

Param Name Description
subnet_id
Optional

サブネットの ID

Validations:

  • Must be String

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


GET /api/domains/:id
ドメインの表示

Params

Param Name Description
id
Required

数値 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/domains
ドメインの作成

The fullname field is used for human readability in reports and other pages that refer to domains, and also available as an external node parameter

Params

Param Name Description
domain
Required

Validations:

  • Must be a Hash

domain[name]
Required

完全な DNS ドメイン名

Validations:

  • Must be String

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

ドメインの説明

Validations:

  • Must be String

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

このドメイン内で使用する DNS プロキシ

Validations:

  • Must be a number.

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

パラメータの配列 (name, value)

Validations:

  • Must be an array of any type


PUT /api/domains/: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.

domain
Required

Validations:

  • Must be a Hash

domain[name]
Optional

完全な DNS ドメイン名

Validations:

  • Must be String

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

ドメインの説明

Validations:

  • Must be String

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

このドメイン内で使用する DNS プロキシ

Validations:

  • Must be a number.

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

パラメータの配列 (name, value)

Validations:

  • Must be an array of any type


DELETE /api/domains/: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.