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
Lista de domínios

GET /api/subnets/:subnet_id/domains
Lista de domínios por subrede

GET /api/locations/:location_id/domains
Lista de domínios por localização

GET /api/organizations/:organization_id/domains
Lista de domínios por organização

Params

Param Name Description
subnet_id
Optional

ID da subrede


Value: Must be String
search
Optional

filtrar resultados


Value: Must be String
order
Optional

ordenar resultados


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por requisições


Value: Must be String

GET /api/domains/:id
Mostrar um domínio

Params

Param Name Description
id
Required

ID númerico ou nome do domínio


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
Criar um domínio

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

Nome de domínio DNS completo


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

Descrição para o domínio


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

Proxy DNS para usar dentro deste domínio


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

Array de parâmetros(name, value)


Value: Must be an array of any type

PUT /api/domains/:id
Atualizar um domínio

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

Nome de domínio DNS completo


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

Descrição para o domínio


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

Proxy DNS para usar dentro deste domínio


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

Array de parâmetros(name, value)


Value: Must be an array of any type

DELETE /api/domains/:id
Apagar um domínio

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.