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
List of domains

Params

Param Name Description
search
Optional

Filter results


Value: Must be String
order
Optional

Sort results


Value: Must be String
page
Optional

paginate results


Value: Must be String
per_page
Optional

Anzahl der Einträge pro Anfrage


Value: Must be String

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

Params

Param Name Description
id
Required

May be numerical id or domain name


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

Params

Param Name Description
domain
Required

Value: Must be a Hash
domain[name]
Required

The full DNS Domain name


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

Voller Name, der die Domäne beschreibt


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

DNS Proxy to use within this domain


Value: Must be a number.
domain[domain_parameters_attributes]
Optional

Array of parameters (name, value)


Value: Must be an array of any type

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

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 , <span class="translation_missing" title="translation missing: de.apipie.nil_allowed">Nil Allowed</span>

The full DNS Domain name


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

Voller Name, der die Domäne beschreibt


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

DNS Proxy to use within this domain


Value: Must be a number.
domain[domain_parameters_attributes]
Optional

Array of parameters (name, value)


Value: Must be an array of any type

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

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.