Группы¶

Получение списка групп¶

Описание¶

Возвращает список групп устройств с входящими в них устройствами

Запрос¶

GET /account/api/group/

Ответ

[
    {
        "name": "string",
        "server_set": [
            {
                "id": "int",
                "addr": "string",
                "status": "string",
                "username": "string",
                "hostname": "string",
                "server_id": "string",
                "connection": "string"
            }
        ],
        "dn": "string"
    }
]

Пример¶

curl --header 'Authorization: Token [TOKEN]' --location 'https://[SERVER_ADDR]/account/api/group/'

Получение информации о группе¶

Описание¶

Возвращает информацию о конкретной группе по её идентификатору

Запрос¶

GET /account/api/group/{id}/

Параметры¶

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

Ответ

{
    "name": "string",
    "server_set": [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string",
            "connection": "string"
        }
    ],
    "dn": "string"
}

Пример¶

curl --header 'Authorization: Token [TOKEN]' --location 'https://[SERVER_ADDR]/account/api/group/1/'

Создание группы¶

Описание¶

Создаёт новую группу устройств. В server_set передаются имена хостов (hostname) устройств, которые должны входить в группу. Если dn не указан, он формируется автоматически на основе имени группы

Запрос¶

POST /account/api/group/

Параметры¶

name — имя группы (обязательно)
server_set — список имён хостов устройств для добавления в группу (необязательно)
dn — Distinguished Name группы (необязательно)

Тело запроса

{
    "name": "string",
    "server_set": [
        "hostname"
    ],
    "dn": "string"
}

Ответ

{
    "name": "string",
    "server_set": [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string",
            "connection": "string"
        }
    ],
    "dn": "string"
}

Пример¶

curl --location --request POST 'https://[SERVER_ADDR]/account/api/group/' \
--header 'Authorization: Token [TOKEN]' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Бухгалтерия",
    "server_set": [ "host1", "host2" ]
}'

Обновление группы (PUT)¶

Описание¶

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

Примечание

При запросе PUT поле server_set полностью перезаписывает текущий список устройств в группе

Запрос¶

PUT /account/api/group/{id}/

Параметры¶

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

Тело запроса

{
    "name": "string",
    "server_set": [
        "hostname"
    ],
    "dn": "string"
}

Ответ

{
    "name": "string",
    "server_set": [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string",
            "connection": "string"
        }
    ],
    "dn": "string"
}

Пример¶

curl --location --request PUT 'https://[SERVER_ADDR]/account/api/group/1/' \
--header 'Authorization: Token [TOKEN]' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Бухгалтерия",
    "server_set": [ "host1", "host2" ]
}'

Обновление группы (PATCH)¶

Описание¶

Частично обновляет данные группы по её идентификатору. В теле запроса передаются только те параметры, которые требуется изменить

Запрос¶

PATCH /account/api/group/{id}/

Параметры¶

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

Тело запроса

{
    "name": "string",
    "server_set": [
        "hostname"
    ],
    "dn": "string"
}

Ответ

{
    "name": "string",
    "server_set": [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string",
            "connection": "string"
        }
    ],
    "dn": "string"
}

Пример¶

curl --location --request PATCH 'https://[SERVER_ADDR]/account/api/group/1/' \
--header 'Authorization: Token [TOKEN]' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Новое имя группы"
}'

Удаление группы¶

Описание¶

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

Запрос¶

DELETE /account/api/group/{id}/

Параметры¶

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

Ответ

204 No Content

Пример¶

curl --location --request DELETE 'https://[SERVER_ADDR]/account/api/group/1/' \
--header 'Authorization: Token [TOKEN]'