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]
选填 , 允许空值

描述该域的全名

Validations:

  • Must be a String

domain[dns_id]
选填 , 允许空值

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
选填

参数阵列(name,value)

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]
选填 , 允许空值

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
选填 , 允许空值

描述该域的全名

Validations:

  • Must be a String

domain[dns_id]
选填 , 允许空值

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
选填

参数阵列(name,value)

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.