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
도메인 목록

GET /api/subnets/:subnet_id/domains
서브넷 별 도메인 목록

GET /api/locations/:location_id/domains
위치별 도메인 목록

GET /api/organizations/:organization_id/domains
조직별 도메인 목록

Params

Param name Description
subnet_id
optional

서브넷 ID

Validations:

  • Must be a String

location_id
optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer

search
optional

필터 결과

Validations:

  • Must be a String

order
optional

결과 정렬

Validations:

  • Must be a String

page
optional

페이지네이션 결과

Validations:

  • Must be a String

per_page
optional

요청 당 항목 수

Validations:

  • Must be a String


GET /api/domains/:id
도메인 표시

Params

Param name Description
id
required

숫자로된 ID 또는 도메인 이름

Validations:

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

show_hidden_parameters
optional

Display hidden parameter values

Validations:

  • Must be one of: true, false, 1, 0


POST /api/domains
도메인 생성

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

전체 DNS 도메인 이름

Validations:

  • Must be a String

domain[fullname]
optional , nil allowed

도메인 설명

Validations:

  • Must be a String

domain[dns_id]
optional , nil allowed

DNS proxy ID to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optional , nil allowed

매개 변수 (이름, 값)의 배열

Validations:

  • Must be an array of any type

domain[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

domain[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


PUT /api/domains/:id
도메인 업데이트

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

전체 DNS 도메인 이름

Validations:

  • Must be a String

domain[fullname]
optional , nil allowed

도메인 설명

Validations:

  • Must be a String

domain[dns_id]
optional , nil allowed

DNS proxy ID to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
optional , nil allowed

매개 변수 (이름, 값)의 배열

Validations:

  • Must be an array of any type

domain[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

domain[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
도메인 삭제

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.