VPN Managers

GET

/api/vpn_managers

Получение списка VPN Managers

Запрос

Параметры запроса:

Name	In	Type	Description
where (Optional)	url parameters	JSON object	Фильтр элементов. Используется синтаксис mongo запросов.
sort (Optional)	url parameters	string	Сортировка элементов.
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.
page (Optional)	url parameters	integer	Номер страницы элементов.
max_results (Optional)	url parameters	integer	Максимальное число элементов на одной странице.

Пример запроса:

curl -X GET http://tkcontrol/api/vpn_managers?sort=name&page=1&max_results=10

Ответ

Пример ответа:

{
    "_items": [
        {
            "_id": "5fa10a15ccb8d1bdb79feee9",
            "name": "skupov-dev-pritunl",
            "server_address": "10.10.56.124",
            "dashboard_address": "https://10.10.56.124",
            "username": "pritunl",
            "password": "*******",
            "_updated": "Tue, 03 Nov 2020 07:43:17 GMT",
            "_created": "Tue, 03 Nov 2020 07:43:17 GMT",
            "_links": {
                "self": {
                    "title": "Vpn_manager",
                    "href": "vpn_managers/5fa10a15ccb8d1bdb79feee9"
                }
            }
        }
    ],
    "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
             "title": "vpn_managers",
             "href": "vpn_managers?max_results=10&sort=name"
        }
    },
    "_meta": {
        "page": 1,
        "max_results": 10,
        "total": 1
    }
}

GET

/api/vpn_managers/{id}

Получение VPN Manager по id

Запрос

Параметры запроса:

Name	In	Type	Description
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.

Пример запроса:

curl -X GET http://tkcontrol/api/vpn_managers/5fa10a15ccb8d1bdb79feee9

Ответ

Пример ответа:

{
    "_id": "5fa10a15ccb8d1bdb79feee9",
    "name": "skupov-dev-pritunl",
    "server_address": "10.10.56.124",
    "dashboard_address": "https://10.10.56.124",
    "username": "pritunl",
    "password": "*******",
    "_updated": "Tue, 03 Nov 2020 07:43:17 GMT",
    "_created": "Tue, 03 Nov 2020 07:43:17 GMT",
    "_links": {
        "self": {
            "title": "Vpn_manager",
            "href": "vpn_managers/5fa10a15ccb8d1bdb79feee9"
        },
        "parent": {
            "title": "home",
            "href": "/"
        },
        "collection": {
            "title": "vpn_managers",
            "href": "vpn_managers"
        }
    }
}

POST

/api/vpn_managers

Создание VPN Manager

Запрос

Пример запроса:

curl -X POST http://tkcontrol/api/vpn_managers -H "Content-Type: application/json" -d '{ \
     { \
         "dashboard_address": "https://10.10.56.124", \
         "name": "example_vpn_manager", \
         "server_address": "10.10.56.124", \
         "username": "pritunl", \
         "password": "some_pass", \
     }'

Ответ

Пример ответа:

{
    "_updated": "Fri, 18 Dec 2020 08:42:49 GMT",
    "_created": "Fri, 18 Dec 2020 08:42:49 GMT",
    "_id": "5fdc6b8998305492eb558cd4",
    "_links": {
        "self": {
            "title": "Vpn_manager",
            "href": "vpn_managers/5fdc6b8998305492eb558cd4"
        }
    },
    "_status": "OK"
}

DELETE

/api/vpn_managers/{id}

Удаление VPN Manager по id

Запрос

Пример запроса:

curl -X DELETE http://tkcontrol/api/vpn_managers/5fdc6b8998305492eb558cd4