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
Список доменов по организациям

Примеры

GET /api/domains
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "fullname": "example577.com",
      "created_at": "2019-09-11 14:41:10 UTC",
      "updated_at": "2019-09-11 14:41:10 UTC",
      "id": 759776770,
      "name": "example577.com",
      "dns_id": null,
      "dns": null
    }
  ]
}

Параметры

Имя параметра Описание
subnet_id
необязательно

Код подсети

Validations:

  • Must be a String

location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип Possible values
fullname string
location string
location_id integer
name string
organization string
organization_id integer
params text

GET /api/domains/:id
Показать домен

Примеры

GET /api/domains/22495316-mydomain-net
200
{
  "fullname": null,
  "created_at": "2019-09-11 14:45:07 UTC",
  "updated_at": "2019-09-11 14:45:07 UTC",
  "id": 22495316,
  "name": "mydomain.net",
  "dns_id": 113629430,
  "dns": {
    "name": "DNS Proxy",
    "id": 113629430,
    "url": "http://else.where:45671"
  },
  "subnets": [
    {
      "id": 980190962,
      "name": "one",
      "description": null,
      "network_address": "2.3.4.0/24"
    }
  ],
  "interfaces": [],
  "parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:45:07 UTC",
      "updated_at": "2019-09-11 14:45:07 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

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
необязательно

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

Примеры

POST /api/domains
{
  "organization_id": null,
  "domain": {
    "name": "example686.com"
  }
}
201
{
  "fullname": null,
  "created_at": "2019-09-11 14:45:08 UTC",
  "updated_at": "2019-09-11 14:45:08 UTC",
  "id": 759776766,
  "name": "example686.com",
  "dns_id": null,
  "dns": null,
  "subnets": [],
  "interfaces": [],
  "parameters": [],
  "locations": [],
  "organizations": []
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

domain
обязательно

Validations:

  • Must be a Hash

domain[name]
обязательно

Полное DNS-имя домена

Validations:

  • Must be a String

domain[fullname]
необязательно , nil разрешен

Описание домена

Validations:

  • Must be a String

domain[dns_id]
необязательно , nil разрешен

DNS proxy ID to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
необязательно , nil разрешен

Массив параметров (имя, значение)

Validations:

  • Must be an array of any type

domain[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

domain[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


PUT /api/domains/:id
Изменить домен

Примеры

PUT /api/domains/22495316-mydomain-net
{
  "domain": {
    "name": "domain.new"
  }
}
200
{
  "fullname": null,
  "created_at": "2019-09-11 14:45:07 UTC",
  "updated_at": "2019-09-11 14:45:08 UTC",
  "id": 22495316,
  "name": "domain.new",
  "dns_id": 113629430,
  "dns": {
    "name": "DNS Proxy",
    "id": 113629430,
    "url": "http://else.where:45671"
  },
  "subnets": [
    {
      "id": 980190962,
      "name": "one",
      "description": null,
      "network_address": "2.3.4.0/24"
    }
  ],
  "interfaces": [],
  "parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:45:07 UTC",
      "updated_at": "2019-09-11 14:45:07 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    }
  ],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

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.

domain
обязательно

Validations:

  • Must be a Hash

domain[name]
необязательно

Полное DNS-имя домена

Validations:

  • Must be a String

domain[fullname]
необязательно , nil разрешен

Описание домена

Validations:

  • Must be a String

domain[dns_id]
необязательно , nil разрешен

DNS proxy ID to use within this domain

Validations:

  • Must be a number.

domain[domain_parameters_attributes]
необязательно , nil разрешен

Массив параметров (имя, значение)

Validations:

  • Must be an array of any type

domain[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

domain[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


DELETE /api/domains/:id
Удалить домен

Примеры

DELETE /api/domains/22495316-mydomain-net
{
  "domain": {}
}
200
{
  "id": 22495316,
  "name": "mydomain.net",
  "fullname": null,
  "created_at": "2019-09-11T14:45:07.866Z",
  "updated_at": "2019-09-11T14:45:07.866Z",
  "dns_id": 113629430
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

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.