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.