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 der Domänen

Parameter

Parametername Beschreibung
search
optional

Filter results

Validations:

  • Must be a String

order
optional

Sort results

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


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

Parameter

Parametername Beschreibung
id
verpflichtend

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

Parameter

Parametername Beschreibung
domain
verpflichtend

Validations:

  • Must be a Hash

domain[name]
verpflichtend

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
optional , nil erlaubt

Voller Name, der die Domäne beschreibt

Validations:

  • Must be a String

domain[dns_id]
optional , nil erlaubt

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optional

Abfolge von Parametern (name, value)

Validations:

  • Must be an array of any type


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

Parameter

Parametername Beschreibung
id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

domain[name]
optional , nil erlaubt

The full DNS Domain name

Validations:

  • Must be a String

domain[fullname]
optional , nil erlaubt

Voller Name, der die Domäne beschreibt

Validations:

  • Must be a String

domain[dns_id]
optional , nil erlaubt

DNS Proxy to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optional

Abfolge von Parametern (name, value)

Validations:

  • Must be an array of any type


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

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

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