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

GET /api/subnets/:subnet_id/domains
Liste der Domänen pro Subnetz

GET /api/locations/:location_id/domains
Liste der Domänen pro Standort

GET /api/organizations/:organization_id/domains
Liste der Domänen pro Organisation

Params

Param Name Description
subnet_id
Optional

Kennung des Subnetzes


Value: Must be String
search
Optional

Ergebnisse filtern


Value: Must be String
order
Optional

Ergebnisse sortieren


Value: Must be String
page
Optional

Ergebnisse nummerieren


Value: Must be String
per_page
Optional

Anzahl der Einträge pro Anfrage


Value: Must be String

GET /api/domains/:id
Domäne anzeigen

Params

Param Name Description
id
Required

Numerische Kennung oder Domänenname


Value: 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
Domäne erstellen

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

Value: Must be a Hash
domain[name]
Required

Der vollständige DNS-Domänenname


Value: Must be String
domain[fullname]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Beschreibung der Domäne


Value: Must be String
domain[dns_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

DNS-Proxy für diese Domäne


Value: Must be a number.
domain[domain_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Abfolge von Parametern (name, value)


Value: Must be an array of any type

PUT /api/domains/:id
Domain Aktualisieren

Params

Param Name Description
id
Required

Value: 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

Value: Must be a Hash
domain[name]
Optional

Der vollständige DNS-Domänenname


Value: Must be String
domain[fullname]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Beschreibung der Domäne


Value: Must be String
domain[dns_id]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

DNS-Proxy für diese Domäne


Value: Must be a number.
domain[domain_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

Abfolge von Parametern (name, value)


Value: Must be an array of any type

DELETE /api/domains/:id
Domäne löschen

Params

Param Name Description
id
Required

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