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

GET /api/subnets/:subnet_id/domains
Lista de dominios por subred

GET /api/locations/:location_id/domains
Listar dominios por ubicación

GET /api/organizations/:organization_id/domains
Listar dominios por organización

Parámetros

Nombre del parámetro Descripción
subnet_id
opcional

ID de la subred

Validations:

  • Must be a String

location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

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
Mostrar un dominio

Parámetros

Nombre del parámetro Descripción
id
requerido

ID numérico o nombre de dominio

Validations:

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

show_hidden_parameters
opcional

Mostrar valores de parámetros ocultos

Validations:

  • Must be one of: true, false, 1, 0


POST /api/domains
Crear un dominio

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

Nombre completo del dominio DNS

Validations:

  • Must be a String

domain[fullname]
opcional , nil permitido

Descripción del dominio

Validations:

  • Must be a String

domain[dns_id]
opcional , nil permitido

ID de proxy DNS a utilizar dentro de este dominio

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
opcional , nil permitido

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type

domain[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

domain[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/domains/:id
Actualizar un dominio

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

Nombre completo del dominio DNS

Validations:

  • Must be a String

domain[fullname]
opcional , nil permitido

Descripción del dominio

Validations:

  • Must be a String

domain[dns_id]
opcional , nil permitido

ID de proxy DNS a utilizar dentro de este dominio

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
opcional , nil permitido

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type

domain[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

domain[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
Borrar un dominio

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.