borderrules (borderrules)
Запросы
HTTP verb | Endpoint | Описание |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Создание нового правила
Запрос
Описание полей: borderrule entity
POST /rest/v1/master/borderrules HTTP/1.1
Content-Type: application/json; charset=utf-8
borderrule entity
Ответ
Описание полей: borderrule entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "9a7a73b7-016c-cd10-9ca9-50e54938780c",
"enabled": 1,
"priority": 91,
"site": "*",
"service": "sip",
"domain": "docs[.]rootdomain[.]ru",
"username": "",
"useragent": "",
"remoteipmask": "0.0.0.0/0",
"action": "allow",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-26T08:35:13.70Z",
"lwt": "2019-08-26T08:35:13.70Z"
}
}
Получение списка правил
Запрос
Имя | Тип | Описание |
---|---|---|
|
|
Фильтр по значениям полей. |
|
|
Список полей для вывода. Доступные поля для выдачи: id, priority, site, domain, username, useragent, remoteipmask, opts.title, ext.lwt, ext.ct. |
|
|
Смещение в списке ресурсов, подлежащих выдаче. |
|
|
Максимальное количество ресурсов в списке. |
|
|
Порядок сортировки ресурсов в списке. |
|
|
Преобразование в плоский вид составных полей. |
GET /rest/v1/master/borderrules?offset=0&limit=5 HTTP/1.1
Ответ
Описание полей: borderrule entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"id": "9a7a73b7-016c-cd10-9ca9-50e54938780c",
"enabled": 1,
"priority": 91,
"site": "",
"service": "sip",
"domain": "docs[.]rootdomain[.]ru",
"username": "",
"useragent": "",
"remoteipmask": "0.0.0.0/0",
"action": "allow",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-26T08:35:13.70Z",
"lwt": "2019-08-26T08:35:13.70Z"
}
},
{
"id": "592aac52-016c-cd11-5ca7-50e54938780c",
"enabled": 1,
"priority": 92,
"site": "",
"service": "sip",
"domain": "",
"username": "abcde",
"useragent": "",
"remoteipmask": "0.0.0.0/0",
"action": "deny",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-27T09:36:14.81Z",
"lwt": "2019-08-27T09:36:14.81Z"
}
},
{
"id": "50b2cff8-016d-1bb6-0054-02004c4f4f50",
"enabled": 1,
"priority": 93,
"site": "",
"service": "sip",
"domain": "",
"username": "",
"useragent": "friendly-scanner.\",
"remoteipmask": "0.0.0.0/0",
"action": "drop",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-28T10:37:15.92Z",
"lwt": "2019-08-28T10:37:15.92Z"
}
},
{
"id": "9f2605a4-016d-1bb7-d504-02004c4f4f50",
"enabled": 1,
"priority": 94,
"site": "SITE1",
"service": "sip",
"domain": "",
"username": "",
"useragent": "",
"remoteipmask": "212.53.40.40/4",
"action": "allow",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-29T11:38:16.03Z",
"lwt": "2019-08-29T11:38:16.03Z"
}
},
{
"id": "0a2cce0d-016d-1bb7-f46b-02004c4f4f50",
"enabled": 1,
"priority": 95,
"site": "SITE2",
"service": "sip",
"domain": "^.test.$",
"username": "test[A-Z]*",
"useragent": "...endly-scann..",
"remoteipmask": "192.168.0.0/24",
"action": "drop",
"opts": {
"title": ""
},
"ext": {
"ct": "2019-08-30T12:39:17.14Z",
"lwt": "2019-08-30T12:39:17.14Z"
}
}
]
Получение данных правила
Запрос
Имя | Тип | Описание |
---|---|---|
|
|
Список полей для вывода. |
|
|
Преобразование в плоский вид составных полей. |
GET /rest/v1/master/borderrules/9a7a73b7-016c-cd10-9ca9-50e54938780c HTTP/1.1
Ответ
Описание полей: borderrule entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "9a7a73b7-016c-cd10-9ca9-50e54938780c",
"enabled": 1,
"priority": 91,
"site": "*",
"service": "sip",
"domain": "docs[.]rootdomain[.]ru",
"username": "",
"useragent": "",
"remoteipmask": "0.0.0.0/0",
"action": "allow",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-26T08:35:13.70Z",
"lwt": "2019-08-26T08:35:13.70Z"
}
}
Изменение данных правила
Поля запрещенные для изменения: id
Запрос
Описание полей: borderrule entity
PATCH /rest/v1/master/borderrules/9a7a73b7-016c-cd10-9ca9-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8
borderrule entity
Ответ
Описание полей: borderrule entity
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id": "9a7a73b7-016c-cd10-9ca9-50e54938780c",
"enabled": 1,
"priority": 91,
"site": "",
"service": "sip",
"domain": "docs[.]rootdomain[.]ru",
"username": "",
"useragent": "friendly-scanner.",
"remoteipmask": "0.0.0.0/0",
"action": "allow",
"opts": {
"title": "",
"comment": ""
},
"ext": {
"ct": "2019-08-26T08:35:13.70Z",
"lwt": "2019-09-10T15:20:51.48Z"
}
}
Удаление правила
Поиск идентификатора правила
Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.
Ключевые поля для поиска: id