Дочерние домены (domains)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/domain/domains

Создание нового дочернего домена

GET

/rest/v1/domain/domains

Получение списка дочерних доменов

GET

/rest/v1/domain/domains/<id>

Получение данных дочернего домена

PATCH

/rest/v1/domain/domains/<id>

Изменение данных дочернего домена

DELETE

/rest/v1/domain/domains/<id>

Удаление дочернего домена

LOOKUP

/rest/v1/domain/domains

Поиск идентификатора дочернего домена

Создание нового дочернего домена

Запрос

Описание полей: domain entity

Пример запроса
POST /rest/v1/domain/domains HTTP/1.1
Content-Type: application/json; charset=utf-8

domain entity

Ответ

Описание полей: domain entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "521944bd-016c-b839-648f-50e54938780c",
  "name": "x.docs.rootdomain.ru",
  "solution": "era",
  "dbdefaultconn": 1,
  "dbhost": "",
  "dblogin": "",
  "dbport": 0,
  "dbpwd": "",
  "lic": {
    "domains": 100,
    "devices": 1000,
    "siptrunks": 5000
  },
  "opts": {
    "title": "",
    "comment": "",
    "isblocked": false,
    "dbuser": "none",
    "script_pause_between_components": 0,
    "script_limit_component_count": -1,
    "script_limit_site_count": -1,
    "script_duration_sec": -1,
    "script_allow_global_variables": true
  },
  "ext": {
    "ct": "2019-08-22T07:27:44.55Z",
    "lwt": "2019-08-22T07:27:44.55Z"
  }
}

Получение списка дочерних доменов

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, name, solution, lic, opts.title, opts.isblocked, opts.dbuser, opts.script_pause_between_components, opts.script_limit_component_count, opts.script_limit_site_count, opts.script_duration_sec, opts.script_allow_global_variables, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса
GET /rest/v1/domain/domains?filter={"opts.isblocked":"false"}&offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: domain entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "521944bd-016c-b839-648f-50e54938780c",
    "name": "x.docs.rootdomain.ru",
    "solution": "era",
    "lic": {
      "domains": 100,
      "devices": 1000,
      "siptrunks": 5000
    },
    "opts": {
      "title": "",
      "isblocked": false,
      "dbuser": "none",
      "script_pause_between_components": 0,
      "script_limit_component_count": -1,
      "script_limit_site_count": -1,
      "script_duration_sec": -1,
      "script_allow_global_variables": true
    },
    "ext": {
      "ct": "2019-08-22T07:27:44.55Z",
      "lwt": "2019-08-22T07:27:44.55Z"
    }
  },
  {
    "id": "2676d846-016c-b839-d915-50e54938780c",
    "name": "y.docs.rootdomain.ru",
    "solution": "era",
    "lic": {
      "domains": 2
    },
    "opts": {
      "title": "",
      "isblocked": false,
      "dbuser": "none",
      "script_pause_between_components": 0,
      "script_limit_component_count": -1,
      "script_limit_site_count": -1,
      "script_duration_sec": -1,
      "script_allow_global_variables": true
    },
    "ext": {
      "ct": "2019-08-22T07:28:14.61Z",
      "lwt": "2019-08-22T07:28:14.61Z"
    }
  }
]

Получение данных дочернего домена

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c HTTP/1.1

Ответ

Описание полей: domain entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "521944bd-016c-b839-648f-50e54938780c",
  "name": "x.docs.rootdomain.ru",
  "solution": "era",
  "dbdefaultconn": 1,
  "dbhost": "",
  "dblogin": "",
  "dbport": 0,
  "dbpwd": "",
  "lic": {
    "domains": 100,
    "devices": 1000,
    "siptrunks": 5000
  },
  "opts": {
    "title": "",
    "comment": "",
    "isblocked": false,
    "dbuser": "none",
    "script_pause_between_components": 0,
    "script_limit_component_count": -1,
    "script_limit_site_count": -1,
    "script_duration_sec": -1,
    "script_allow_global_variables": true
  },
  "ext": {
    "ct": "2019-08-22T07:27:44.55Z",
    "lwt": "2019-08-22T07:27:44.55Z"
  }
}

Изменение данных дочернего домена

Поля запрещенные для изменения: id, name, solution

Запрос

Описание полей: domain entity

Пример запроса
PATCH /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

domain entity

Ответ

Описание полей: domain entity

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "521944bd-016c-b839-648f-50e54938780c",
  "name": "x.docs.rootdomain.ru",
  "solution": "era",
  "dbdefaultconn": 1,
  "dbhost": "",
  "dblogin": "",
  "dbport": 0,
  "dbpwd": "",
  "lic": {
    "domains": 120,
    "devices": 1200,
    "siptrunks": 5500
  },
  "opts": {
    "title": "",
    "comment": "",
    "isblocked": false,
    "dbuser": "read",
    "script_pause_between_components": 1,
    "script_limit_component_count": 100,
    "script_limit_site_count": 100,
    "script_duration_sec": 60,
    "script_allow_global_variables": false
  },
  "ext": {
    "ct": "2019-08-22T07:27:44.55Z",
    "lwt": "2019-09-10T21:35:27.41Z"
  }
}

Удаление дочернего домена

Запрос

Пример запроса
DELETE /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора дочернего домена

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id, name

Запрос

Пример запроса
LOOKUP /rest/v1/domain/domains HTTP/1.1
Content-Type: application/json; charset=utf-8

"x.docs.rootdomain.ru"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "521944bd-016c-b839-648f-50e54938780c"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}

Содержание (дочерние ресурсы)

  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт