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
Liste des domaines

Paramètres

Nom du paramètre Description
search
optionel

Filter results

Validations:

  • Must be a String

order
optionel

Sort results

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entier par requête

Validations:

  • Must be a String


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

Paramètres

Nom du paramètre Description
id
requis

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

Paramètres

Nom du paramètre Description
domain
requis

Validations:

  • Must be a Hash

domain[name]
requis

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
optionel , nil autorisé

Nom complet décrivant le domaine

Validations:

  • Must be a String

domain[dns_id]
optionel , nil autorisé

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optionel

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type


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

Paramètres

Nom du paramètre Description
id
requis

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
requis

Validations:

  • Must be a Hash

domain[name]
optionel , nil autorisé

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
optionel , nil autorisé

Nom complet décrivant le domaine

Validations:

  • Must be a String

domain[dns_id]
optionel , nil autorisé

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optionel

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type


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

Paramètres

Nom du paramètre Description
id
requis

Validations:

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