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 of 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
ドメインの一覧

パラメーター

パラメーター名 記述
search
任意

Filter results

Validations:

  • Must be a String

order
任意

Sort results

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /api/domains/:id
Show a domain.

パラメーター

パラメーター名 記述
id
必須

May be numerical id or domain name

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
Create a domain.

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

パラメーター

パラメーター名 記述
domain
必須

Validations:

  • Must be a Hash

domain[name]
必須

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
任意 , nil可

ドメインを表すフルネーム

Validations:

  • Must be a String

domain[dns_id]
任意 , nil可

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
任意

パラメーター (名前、値) の配列

Validations:

  • Must be an array of any type


PUT /api/domains/:id
Update a domain.

パラメーター

パラメーター名 記述
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.

domain
必須

Validations:

  • Must be a Hash

domain[name]
任意 , nil可

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
任意 , nil可

ドメインを表すフルネーム

Validations:

  • Must be a String

domain[dns_id]
任意 , nil可

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
任意

パラメーター (名前、値) の配列

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
Delete a domain.

パラメーター

パラメーター名 記述
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.