Центр управления устройствами REST API
by virusatl

Центр управления устройствами REST API

REST API для центра управления устройствами
Исключения

Схемы исключений

NotFoundException

Данное исключение возращается когда запись не найдена или страницы не существует

Object
status
boolean
Example:
false
data
Object
message
string
Example:
Not Found
url
string
Example:
/api/device-config/delete
code
integer
Example:
404
Пример
{
    "status": false,
    "data": {
        "message": "Not Found",
        "url": "/api/device-config/delete",
        "code": 404
    }
}
BadRequestException

Данное исключение возращается когда в заросе не переданы нужные данные

Object
status
boolean
Example:
false
data
Object
message
string
Example:
Bad Request
url
string
Example:
/api/device-config/delete
code
integer
Example:
400
Пример
{
    "status": false,
    "data": {
        "message": "Bad Request",
        "url": "/api/device-config/delete",
        "code": 400
    }
}
MethodNotAllowedException

Данное исключение возращается когда был использован неразрешенный метод для запроса

Object
status
boolean
Example:
false
data
Object
message
string
Example:
Method Not Allowed
url
string
Example:
/api/users/login
code
integer
Example:
405
Пример
{
    "status": false,
    "data": {
        "message": "Method Not Allowed",
        "url": "/api/users/login",
        "code": 405
    }
}
UnauthorizedException

Данное исключение возращается когда пользователь ввел неверные имя пользователя или пароль или неавторизован в системе.

Object
status
boolean

Статус операции

Example:
false
data
Object
message
string
Examples:
Invalid username or passwordYou are not authorized to access that location.
url
string
Example:
/api/users/login
code
number
Example:
401
Пример
{
    "status": false,
    "data": {
        "message": "You are not authorized to access that location.",
        "url": "/api/users/login",
        "code": 401
    }
}
Вход в систему

Операции для входа в систему

Авторизация
POST /api/users/login
Авторизация
POST /api/users/login

Авторизация в системе и получение токена.

Request body

Object
email
string

Email вашего аккаунта

password
string

Пароль от вашего аккаунта

Examples
{
    "email": "test@test.com",
    "password": "testpassword"
}

Responses

401 Unauthorized

Ошибка авторизации

Body
UnauthorizedException
Examples
{
    "status": false,
    "data": {
        "message": "Invalid username or password",
        "url": "/api/users/login",
        "code": 401
    }
}
405 Method Not Allowed

Запрещенный метод

Body
MethodNotAllowedException
Examples
{
    "status": false,
    "data": {
        "message": "Method Not Allowed",
        "url": "/api/users/login",
        "code": 405
    }
}
200 OK

Авторизация успешна

Body
Object
status
boolean
data
Object
token
string
Пример
POST http://192.168.10.123/api/users/login HTTP/1.1 

Content-Type: application/json

{
    "email": "test@test.com",
    "password": "testpassword"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": true,
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImV4cCI6MTU1OTY0Mzc4N30.T0P8tFNTfLl61cefPWkP7Puz9bAix4ZtB8_veL40gFY"
    }
}
Обязательный заголовок после получения токена

После того как вы авторизовались и получили токен. Во все запросы необходимо добавлять заголовок с данным токеном.

Заголовок: Authorization Значение заголовка: Bearer {TOKEN}

Пример
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImV4cCI6MTU1OTcyNDc0Mn0.TVA1Q17gMMc8EmspxuILVJKgEyUfegb_49nuYOmmbD0
Устройства и группы

Получение списка устройств и списка групп

Получение списка устройств
POST /api/devices/index
Получение списка групп
GET /api/devices/groups
Получение списка устройств
POST /api/devices/index

Authentication

Token

Возвращает список устройств доступных пользователю + фильт/сортировка/пагинация

Request parameters

limit
integer optional

Количество устройств в выдаче

Min: 1
Default:
25
page
integer optional

Номер страницы пагинации

Min: 1
sort
string optional

Название поля для сортировки

Enumeration:
device_id
device_name
device_type
login
firmware_version
comment
blocked
ovpn_ip
fvpn_ifname
fvpn_channels
fvpn_ip_client
fvpn_ip_server
fvpn_netmask
fvpn_mtu
aggregator
vlan
group
service_id
service

Служебно название услуги

direction
string optional

Направление сортировки

Enumeration:
desc
asc

Request body

Object
filter
Object

(Опционально)

group
integer

(Опционально) идентификатор группы

Example:
10
online
integer

(Опционально) 0 - не в сети 1 - в сети

Min: 0
Max: 1
query
string

(Опционально) Строка поиска, ищет по всем поля

Min length: 3

Responses

200 OK
Body
Object
status
boolean
Example:
true
data
Array
Object
device_id
integer

Идентификатор устройства

Example:
21
device_name
string

Наименование устройства

Example:
BN014000000057
device_type
string

Тип устройства(железо)

Example:
Fotel BL-01
login
string
Example:
3935972275337519060
firmware_version
string

Номер прошивки

Example:
1.40.4
comment
string

Комментарий

Example:
Тестовое устройство
blocked
boolean

Флаг блокировки устройства

Examples:
truefalse
ovpn_ip
string

IP адрес управления

Example:
192.168.108.25
fvpn_ifname
string

Имя интерфейса канала агрегации

Example:
ftap108_25
fvpn_channels
string

Количество каналов

Example:
2
fvpn_ip_client
string

IP адрес клиентской точки

Example:
10.1.1.2
fvpn_ip_server
string

IP адрес серверной точки

Example:
10.1.1.1
fvpn_netmask
string

Сетевая маска

Example:
255.255.255.252
fvpn_mtu
integer

MTU интерфейса

Example:
1500
aggregator
string

Текущий сервер агрегации(IP адрес)

Example:
11.11.11.11
vlan
string

Текущий VLAN

Example:
1515
group
Object
id
integer

Идентефикатор группы

Example:
1
name
string

Название группы

Example:
Тест
service_id
integer

ID услуги

Example:
10
service
string

Служебное название услуги

Example:
no_service
pagination
Object

Текущие параметры пагинации

page_count
integer

Количество страниц

Example:
20
current_page
integer

Текущая страница

Example:
0
has_next_page
boolean

Флаг наличия следующей страницы

Example:
true
has_prev_page
boolean

Флаг наличия предыдущей страницы

Example:
false
count
integer

Всего записей

Example:
250
limit
integer

Записей на страницу

Example:
25
show more
401 Unauthorized
Body
UnauthorizedException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример 1
Пример 2

Пример без параметров

POST http://192.168.10.123/api/devices/index HTTP/1.1 

Content-Type: application/json

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true",
    "data": [
        {
            "device_id": 21,
            "device_name": "BN014000000057",
            "device_type": "Fotel BL-01",
            "login": "3935972275337519060",
            "firmware_version": "1.40.4",
            "comment": "Тестовое устройство",
            "blocked": "false",
            "ovpn_ip": "192.168.108.25",
            "fvpn_ifname": "ftap108_25",
            "fvpn_channels": "2",
            "fvpn_ip_client": "10.1.1.2",
            "fvpn_ip_server": "10.1.1.1",
            "fvpn_netmask": "255.255.255.252",
            "fvpn_mtu": 1500,
            "aggregator": "11.11.11.11",
            "vlan": "1515",
            "service_id": 10,
            "service": "atm",
            "group": {
                "id": 1,
                "name": "Тест"
            }
        },
        {...}
    ],
    "pagination": {
        "page_count": 20,
        "current_page": 1,
        "has_next_page": "true",
        "has_prev_page": "false",
        "count": 250,
        "limit": 25
    }
}
show more

пример с параметрами

POST http://192.168.10.123/api/devices/index?limit=5&page=3&sort=device_id&direction=asc HTTP/1.1 

Content-Type: application/json

{
    "filter": {
        "group": 10,
        "online": 1,
        "query": "тест"
    }
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true",
    "data": [
        {
            "device_id": 21,
            "device_name": "BN014000000057",
            "device_type": "Fotel BL-01",
            "login": "3935972275337519060",
            "firmware_version": "1.40.4",
            "comment": "Тестовое устройство",
            "blocked": "false",
            "ovpn_ip": "192.168.108.25",
            "fvpn_ifname": "ftap108_25",
            "fvpn_channels": "2",
            "fvpn_ip_client": "10.1.1.2",
            "fvpn_ip_server": "10.1.1.1",
            "fvpn_netmask": "255.255.255.252",
            "fvpn_mtu": 1500,
            "aggregator": "11.11.11.11",
            "vlan": "1515",
            "service_id": 0,
            "service": "no_service",
            "group": {
                "id": 10,
                "name": "Тест"
            }
        },
        {...},
        ...
    ],
    "pagination": {
        "page_count": 10,
        "current_page": 3,
        "has_next_page": true,
        "has_prev_page": true,
        "count": 50,
        "limit": 5
    }
}
show more
Получение списка групп
GET /api/devices/groups

Authentication

Token

Возвращает список групп доступных пользователю

Responses

200 OK
Body
Object
status
boolean
Example:
true
data
Array
Object
id
integer

Идентефикатор группы

parent_id
integer

Идентефикатор родительской группы

name
string

Название группы

401 Unauthorized
Body
UnauthorizedException
405 Method Not Allowed

Запрещенный метод

Body
MethodNotAllowedException
Пример
Исключение
GET http://192.168.10.123/api/devices/groups HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": true,
    "data": [
        {
            "id": 1,
            "parent_id": null,
            "name": "Тест"
        },
        {
            "id": 2,
            "parent_id": 1,
            "name": "Тест1"
        }
    ]
}
POST http://192.168.10.123/api/devices/groups HTTP/1.1 

HTTP/1.1 405 Method Not Allowed 

Content-Type: application/json

{
    "status": false,
    "data": {
        "message": "Method Not Allowed",
        "url": "/api/devices/groups",
        "code": 405
    }
}
Экспорт конфигурации устройства

В этом разделе представлен API для создания и устравления конфигурацией устройств.

Получение журнала
GET /api/device-config/index
Получение экспорта конфигурации
GET /api/device-config/view/{config_id}
Добавление экспорта
POST /api/device-config/add
Удаление экспорта
POST /api/device-config/delete
Удаление устройства из экспорта
POST /api/device-config/delete-dev
Подтверждение экспорта
POST /api/device-config/confirm
Отмена экспорта
POST /api/device-config/cancel
Получение журнала
GET /api/device-config/index

Authentication

Token

Получает список экспортируемой конфигурации

Request parameters

limit
integer optional

Количество записей в выдаче

Min: 1
Default:
25
page
integer optional

Номер страницы пагинации

Min: 1
sort
string optional

Название поля для сортировки

Enumeration:
config_id

идентефикатор экспорта

date_start

дата начала экспорта

date_complete

дата окончания

status

текущий статус

data

что экпортируется

device_id

идентефикатор мастер устройства

user_id

идентефикатор пользователя(создатель)

ap_user_id

идентефикатор пользователя(подтвердил)

direction
string optional

Направление сортировки

Enumeration:
desc
asc

Responses

200 OK
Body
Object
status
boolean
Example:
true
data
Array
Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
57
date_start
string

Дата/Время начала

Example:
2019-06-04T14:27:16+03:00
date_complete
string

Дата/Время завершения

Examples:
null2019-06-05T14:27:16+03:00
status
string

Текущий статус

Enumeration:
WAIT_AP

Ожидание подтверждения действия от вышестоящего пользователя

NOT_AP

Действие не подтверждено

COMPLETE

Завершено

IN_PROCESS

В процессе

data
string

Какая конфигурация экспортирутся

Example:
{"snmpd":"1"}
user
Object

Пользователь который создал экспорт конфигурации

id
integer

Идентефикатор пользователя

Example:
100
email
string

Логин пользователя

Example:
test@test.com
fio
string

ФИО пользователя

Example:
Вася Пупкин
ap_user
Object

Пользователь который подтвердил или отменил экспорт конфигурации

id
integer

Идентефикатор пользователя

Example:
101
email
string

Логин пользователя

Example:
testap@test.com
fio
string

ФИО пользователя

Example:
Иванов Иван Иваныч
device_config_devices
Array

Устройства на которые заливается конфигурация

Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
57
device_id
integer

Идентефикатор устройства

Example:
99
status
string

Статус экспорта для этого устройства

Enumeration:
COMPLETE

Завершено

IN_PROGRESS

В процессе, еще не завершеною

data_complete
string

Дата завершения

Examples:
null2019-06-04T14:27:17+03:00
device
Object

Устройство с которого заливается конфигурация

device_id
integer

Идентефикатор устройства

Example:
10
device_name
string

Наименование устройства

Example:
BN014000000014
device_type
string

Тип устройства

Example:
Fotel BL-01
group_id
integer

Группа устройства

Example:
5
login
string

Логин устройства

Example:
12345678910
firmware_version
string

Версия прошивки

Example:
1.38.8
comment
string

Комментарий к устройству

Example:
Пропа пер
blocked
boolean

Флаг блокировки устройства

Example:
false
pagination
Object
page_count
integer

Количество страниц

Example:
1
current_page
integer

Текущая страница

Example:
1
has_next_page
boolean

Флаг наличия следующей страницы

Example:
false
has_prev_page
boolean

Флаг наличия предыдущей страницы

Example:
false
count
string

Всего записей

Example:
20
limit
integer

Количество записей на страницу

Example:
25
show more
401 Unauthorized
Body
UnauthorizedException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример
GET http://192.168.10.123/api/device-config/index HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true",
    "data": [
        {
            "config_id": 57,
            "date_start": "2019-06-04T14:27:16+03:00",
            "date_complete": "null",
            "status": "IN_PROCESS",
            "data": "{\"snmpd\":\"1\"}",
            "user": {
                "id": 100,
                "email": "test@test.com",
                "fio": "Вася Пупкин"
            },
            "ap_user": {
                "id": 101,
                "email": "testap@test.com",
                "fio": "Иванов Иван Иваныч"
            },
            "device_config_devices": [
                {
                    "config_id": 57,
                    "device_id": 99,
                    "status": "IN_PROGRESS",
                    "data_complete": "null"
                }
            ],
            "device": {
                "device_id": 10,
                "device_name": "BN014000000014",
                "device_type": "Fotel BL-01",
                "group_id": 5,
                "login": "12345678910",
                "firmware_version": "1.38.8",
                "comment": "Пропа пер",
                "blocked": "false"
            }
        }
    ],
    "pagination": {
        "page_count": 1,
        "current_page": 1,
        "has_next_page": "false",
        "has_prev_page": "false",
        "count": "20",
        "limit": 25
    }
}
show more
Получение экспорта конфигурации
GET /api/device-config/view/{config_id}

Authentication

Token

Получает экспорт конфигурации по индентефикатору

Path variables

config_id
integer required

Идентефикатор экпорта конфигурации

Responses

200 OK
Body
Object
status
boolean
Example:
true
data
Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
57
date_start
string

Дата/Время начала

Example:
2019-06-04T14:27:16+03:00
date_complete
string

Дата/Время завершения

Examples:
2019-06-05T14:27:16+03:00null
status
string

Текущий статус

Enumeration:
WAIT_AP

Ожидание подтверждения действия от вышестоящего пользователя

NOT_AP

Действие не подтверждено

COMPLETE

Завершено

IN_PROCESS

В процессе

data
string

Какая конфигурация экспортирутся

Example:
{"snmpd":"1"}
user
Object

Пользователь который создал экспорт конфигурации

id
integer

Идентефикатор пользователя

Example:
100
email
string

Логин пользователя

Example:
test@test.com
fio
string

ФИО пользователя

Example:
Вася Пупкин
ap_user
Object

Пользователь который подтвердил или отменил экспорт конфигурации

id
string

Идентефикатор пользователя

Example:
100
email
string

Логин пользователя

Example:
test@test.com
fio
string

ФИО пользователя

Example:
Вася Пупкин
device_config_devices
Array

Устройства на которые заливается конфигурация

Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
57
device_id
integer

Идентефикатор устройства

Example:
10
status
string

Статус экспорта для этого устройства

Enumeration:
IN_PROGRESS

В процессе, еще не завершеною

COMPLETE

Завершено

data_complete
string

Дата завершения

Examples:
2019-06-04T14:27:17+03:00null
device
Object

Устройство с которого заливается конфигурация

device_id
integer

Идентефикатор устройства

Example:
10
device_name
string

Наименование устройства

Example:
BN014000000014
device_type
string

Тип устройства

Example:
Fotel BL-01
group_id
integer

Группа устройства

Example:
5
login
string

Логин устройства

Example:
12345678910
firmware_version
string

Версия прошивки

Example:
1.38.8
comment
string

Комментарий к устройству

Example:
Бла бла бла
blocked
boolean

Флаг блокировки устройства

Example:
false
show more
400 Bad Request
Body
BadRequestException
401 Unauthorized
Body
UnauthorizedException
404 Not Found
Body
NotFoundException
Пример
GET http://192.168.10.123/api/device-config/view/57 HTTP/1.1 

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true",
    "data": {
        "config_id": 57,
        "date_start": "2019-06-04T14:27:16+03:00",
        "date_complete": "null",
        "status": "WAIT_AP",
        "data": "{\"snmpd\":\"1\"}",
        "user": {
            "id": 100,
            "email": "test@test.com",
            "fio": "Вася Пупкин"
        },
        "ap_user": {
            "id": "100",
            "email": "test@test.com",
            "fio": "Вася Пупкин"
        },
        "device_config_devices": [
            {
                "config_id": 57,
                "device_id": 10,
                "status": "IN_PROGRESS",
                "data_complete": "2019-06-04T14:27:17+03:00"
            }
        ],
        "device": {
            "device_id": 10,
            "device_name": "BN014000000014",
            "device_type": "Fotel BL-01",
            "group_id": 5,
            "login": "12345678910",
            "firmware_version": "1.38.8",
            "comment": "Бла бла бла",
            "blocked": "false"
        }
    }
}
show more
Добавление экспорта
POST /api/device-config/add

Authentication

Token

Добавляет новую запись в экпорт конфигурации

Request body

Object
device_id
integer required

Идентефикатор мастер устройства

date_start
string

Дата/Время начала

Example:
2019-05-30 20:00:00
data
Object required
network
boolean

Конфигурация сети

firewall
boolean

Конфиррация межсетевого экрана

dhcp
boolean

Конфигурация DHCP

qos
boolean

Конфигурация Quality Of Service

wifi
boolean

Конфигурация WIFI

snmpd
boolean

Конфигурация SNMP

qcmi
boolean

Конфигурация модемов и агрегации

openvpn
boolean

Конфигурация OpenVpn

dropbear
boolean

Конфигурация SSH

chilli
boolean

Конфигурация CaptivePortal

users
boolean

Конфигурация пользователей(Права/Пароли/Пользователи)

device_config_devices
Array required

Масси устройств для заливки конфигурации

Object
device_id
integer required

Идентефикатор устройства на который будет заливаться конфигурация

Example:
101
show more

Responses

200 OK
Body
Object
status
boolean
Examples:
truefalse
deviceConfig
Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
10
device_id
integer

Идентефикатор мастер устройства

Example:
101
date_start
string

Дата/Время начала

Example:
2019-06-04T14:27:16+03:00
status
string

Текущий статус

Example:
WAIT_AP
user_id
integer

Идентефикатор пользователя

Example:
5
data
string

Какая конфигурация экспортирутся

Example:
{"snmpd":"1"}
device_config_devices
Array

Масси устройств для заливки конфигурации

Object
device_id
integer

Идентефикатор устройства

Example:
110
status
string

Статус экспорта для этого устройства

Example:
IN_PROGRESS
errors
Object

Ошибки валидации, если есть

field_name
Object

Наименование поля, в котором произошла ошибка

Example: 
"errors": {
      "status": {
        "inList": "The provided value is invalid"
      }
    }
error_name_key
string

Наименование ошибки и сообщение ошибки

field_name_1
Object

Наименование поля, в котором произошла ошибка

Example: 
"errors": {
      "device_config_devices": {
        "1": {
          "device_id": {
            "verifyDevice": "Device not the same to master check device with id:202"
          }
        }
      }
    }
error_index
Object

Порядковый номер ошибки

field_name_2
Object
error_name_key_2
string
show more
401 Unauthorized
Body
UnauthorizedException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример 1
Пример 2
POST http://192.168.10.123/api/device-config/add HTTP/1.1 

Content-Type: application/json

{
    "device_id": 100,
    "date_start": "2019-05-30 20:00:00",
    "data": {
        "network": 0,
        "firewall": 0,
        "dhcp": 0,
        "qos": 0,
        "wifi": 0,
        "snmpd": 1,
        "qcmi": 0,
        "openvpn": 0,
        "dropbear": 0,
        "chilli": 0,
        "users": 0
    },
    "device_config_devices": [
        {
            "device_id": 101
        },
        {
            "device_id": 102
        }
    ]
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": true,
    "deviceConfig": {
        "config_id": 10,
        "device_id": 100,
        "date_start": "2019-06-04T14:27:16+03:00",
        "status": "WAIT_AP",
        "user_id": 5,
        "data": "{\"snmpd\":\"1\"}",
        "device_config_devices": [
            {
                "device_id": 101,
                "status": "IN_PROGRESS"
            },
            {
                "device_id": 102,
                "status": "IN_PROGRESS"
            }
        ]
    }
}
show more

Пример с ошибками валидации

POST http://192.168.10.123/api/device-config/add HTTP/1.1 

Content-Type: application/json

{
    "device_id": 1,
    "date_start": "2019-05-30 20:00:00",
    "data": {
        "network": true,
        "firewall": true,
        "dhcp": true,
        "qos": true,
        "wifi": true,
        "snmpd": true,
        "qcmi": true,
        "openvpn": true,
        "dropbear": true,
        "chilli": true,
        "users": true
    },
    "device_config_devices": [
        {
            "device_id": 101
        }
    ]
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "flase",
    "deviceConfig": {
        "device_id": 101,
        "date_start": "2019-06-04T14:27:16+03:00",
        "status": "WAIT_AP",
        "user_id": 5,
        "data": "{\"snmpd\":\"1\"}",
        "device_config_devices": [
            {
                "device_id": 110,
                "status": "IN_PROGRESS"
            }
        ]
    },
    "errors": {
        "status": {
            "inList": "The provided value is invalid"
        },
        "device_config_devices": {
            "1": {
                "device_id": {
                    "verifyDevice": "Device not the same to master check device with id:202"
                }
            }
        }
    }
}
show more
Удаление экспорта
POST /api/device-config/delete

Authentication

Token

Удаляет экспорт конфигурации

Request body

Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
10

Responses

200 OK
Body
Object
status
boolean
Examples:
truefalse
400 Bad Request
Body
BadRequestException
401 Unauthorized
Body
UnauthorizedException
404 Not Found
Body
NotFoundException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример
POST http://192.168.10.123/api/device-config/delete HTTP/1.1 

Content-Type: application/json

{
    "config_id": 10
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true"
}
Удаление устройства из экспорта
POST /api/device-config/delete-dev

Authentication

Token

Удаляет устройство из конкретного экспорта конфигурации

Request body

Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
10
device_id
integer

Идентефикатор устройства

Example:
101

Responses

200 OK
Body
Object
status
boolean
Examples:
truefalse
400 Bad Request
Body
BadRequestException
401 Unauthorized
Body
UnauthorizedException
404 Not Found
Body
NotFoundException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример
POST http://192.168.10.123/api/device-config/delete-dev HTTP/1.1 

Content-Type: application/json

{
    "config_id": 10,
    "device_id": 101
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true"
}
Подтверждение экспорта
POST /api/device-config/confirm

Authentication

Token

Подтверждение экспорта конфигурации вышестоящим пользователем

Request body

Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
10

Responses

200 OK
Body
Object
status
boolean
Examples:
truefalse
400 Bad Request
Body
BadRequestException
401 Unauthorized
Body
UnauthorizedException
404 Not Found
Body
NotFoundException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример
POST http://192.168.10.123/api/device-config/confirm HTTP/1.1 

Content-Type: application/json

{
    "config_id": 10
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true"
}
Отмена экспорта
POST /api/device-config/cancel

Authentication

Token

Отмена экспорта конфигурации вышестоящим пользователем

Request body

Object
config_id
integer

Идентефикатор экспорта конфигурации

Example:
65

Responses

200 OK
Body
Object
status
boolean
Examples:
truefalse
400 Bad Request
Body
BadRequestException
401 Unauthorized
Body
UnauthorizedException
404 Not Found
Body
NotFoundException
405 Method Not Allowed
Body
MethodNotAllowedException
Пример
POST http://192.168.10.123/api/device-config/cancel HTTP/1.1 

Content-Type: application/json

{
    "config_id": 65
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "status": "true"
}