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
Lista de dominios

Parámetros

Nombre del parámetro Descripción
search
opcional

Filter results

Validations:

  • Must be a String

order
opcional

Sort results

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


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

Parámetros

Nombre del parámetro Descripción
id
requerido

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

Parámetros

Nombre del parámetro Descripción
domain
requerido

Validations:

  • Must be a Hash

domain[name]
requerido

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
opcional , nil permitido

Nombre completo que describe el dominio

Validations:

  • Must be a String

domain[dns_id]
opcional , nil permitido

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
opcional

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type


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

Parámetros

Nombre del parámetro Descripción
id
requerido

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
requerido

Validations:

  • Must be a Hash

domain[name]
opcional , nil permitido

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
opcional , nil permitido

Nombre completo que describe el dominio

Validations:

  • Must be a String

domain[dns_id]
opcional , nil permitido

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
opcional

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type


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

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

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