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
List of domains

GET /api/subnets/:subnet_id/domains
List of domains per subnet

GET /api/locations/:location_id/domains
List of domains per location

GET /api/organizations/:organization_id/domains
List of domains per organization

参数

参数名字 描述
subnet_id
选填

ID of subnet


Value:

Must be String

search
选填

过滤结果


Value:

Must be String

order
选填

结果排序


Value:

Must be String

page
选填

页数


Value:

Must be String

per_page
选填

每个请求中的条目数


Value:

Must be String


GET /api/domains/:id
Show a domain

参数

参数名字 描述
id
必填

Numerical ID or domain name


Value:

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
必填

Value:

Must be a Hash

domain[name]
必填

The full DNS domain name


Value:

Must be String

domain[fullname]
选填 , 允许空值

Description of the domain


Value:

Must be String

domain[dns_id]
选填 , 允许空值

DNS proxy to use within this domain


Value:

Must be a number.

domain[domain_parameters_attributes]
选填 , 允许空值

Array of parameters (name, value)


Value:

Must be an array of any type


PUT /api/domains/:id
Update a domain

参数

参数名字 描述
id
必填

Value:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

domain
必填

Value:

Must be a Hash

domain[name]
选填

The full DNS domain name


Value:

Must be String

domain[fullname]
选填 , 允许空值

Description of the domain


Value:

Must be String

domain[dns_id]
选填 , 允许空值

DNS proxy to use within this domain


Value:

Must be a number.

domain[domain_parameters_attributes]
选填 , 允许空值

Array of parameters (name, value)


Value:

Must be an array of any type


DELETE /api/domains/:id
Delete a domain

参数

参数名字 描述
id
必填

Value:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.