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

GET /api/subnets/:subnet_id/domains
Liste des domaines par sous-réseau

GET /api/locations/:location_id/domains
Liste des domaines par emplacement

GET /api/organizations/:organization_id/domains
Liste des domaines par organisation

Params

Param Name Description
subnet_id
Optional

ID du sous-réseau

Validations:

  • Must be String

search
Optional

filtrer les résultats

Validations:

  • Must be String

order
Optional

trier les resultats

Validations:

  • Must be String

page
Optional

paginer les résultats

Validations:

  • Must be String

per_page
Optional

nombre d'entier par requête

Validations:

  • Must be String


GET /api/domains/:id
Afficher un domaine

Params

Param Name Description
id
Required

ID numérique ou nom de domaine

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
Créer un domaine

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

Params

Param Name Description
domain
Required

Validations:

  • Must be a Hash

domain[name]
Required

Le nom DNS complet

Validations:

  • Must be String

domain[fullname]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Description du domaine

Validations:

  • Must be String

domain[dns_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Proxy DNS à utiliser pour ce domaine

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type


PUT /api/domains/:id
Mise à jour d'un domaine

Params

Param Name Description
id
Required

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
Required

Validations:

  • Must be a Hash

domain[name]
Optional

Le nom DNS complet

Validations:

  • Must be String

domain[fullname]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Description du domaine

Validations:

  • Must be String

domain[dns_id]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Proxy DNS à utiliser pour ce domaine

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
Supprimer un domaine

Params

Param Name Description
id
Required

Validations:

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