Задачи

Получение списка с задачами

Запрос:

GET /automation/api/job/

Ответ

{
    "id": "int",
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers":
    [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string"
        }
    ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Получение информации о задаче

Запрос:

GET /automation/api/job/{id}/

Ответ

{
    "id": "int",
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers":
    [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string"
        }
    ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Получение статуса задачи

Запрос:

GET /automation/api/job/{id}/status/

Ответ

{
    "status": "string",
    "id": "int",
    "name": "string"
}

Создание задачи

Запрос:

POST /automation/api/job/

Тело запроса

{
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers": [ "string" ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Ответ

{
    "id": "int",
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers":
    [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string"
        }
    ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Обновление задачи PUT

Описание: Этот запрос обновляет данные задачи с указанным идентификатором {id}. В теле запроса передаются обновляемые параметры задачи

Примечание

Убедитесь, что вы указываете все поля тела запроса корректно, так как неверный формат данных может привести к ошибке при выполнении запроса

Запрос:

PUT /automation/api/job/{id}/

Тело запроса

{
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers": [ "string" ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Ответ

{
    "id": "int",
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers":
    [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string"
        }
    ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Пример:

curl --location --request PUT 'https://[SERVER_ADDR]/automation/api/job/123/' \
--header 'Authorization: Token [TOKEN]' \
--header 'Content-Type: application/json' \
--data '{
"name": "Название задачи",
"notify": false,
"params": "Параметры",
"enabled": true,
"run_on_start": true,
"groups": [ 1 ],
"peers": [ "alt10", "windows7" ],
"policies": [ 1 ],
"dynamic_groups": [ 1 ]}'

Обновление задачи PATCH

Описание: Этот запрос обновляет данные задачи с указанным идентификатором {id}. В теле запроса передаются обновляемые параметры задачи

Примечание

Убедитесь, что вы указываете все поля тела запроса корректно, так как неверный формат данных может привести к ошибке при выполнении запроса

Запрос:

PATCH /automation/api/job/{id}/

Тело запроса

{
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers": [ "string" ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Ответ

{
    "id": "int",
    "name": "string",
    "notify": "boolean",
    "params": "string",
    "enabled": "boolean",
    "run_on_start": "boolean",
    "groups": [ "int" ],
    "peers":
    [
        {
            "id": "int",
            "addr": "string",
            "status": "string",
            "username": "string",
            "hostname": "string",
            "server_id": "string"
        }
    ],
    "policies": [ "int" ],
    "dynamic_groups": [ "int" ]
}

Пример:

curl --location --request PATCH 'https://[SERVER_ADDR]/automation/api/job/123/' \
--header 'Authorization: Token [TOKEN]' \
--header 'Content-Type: application/json' \
--data '{
"name": "Название задачи",
"notify": true,
"enabled": true,
"run_on_start": false,
"groups": [ 1 ],
"peers":
[ "alt10", "windows7" ],
"policies": [ 1 ],
"dynamic_groups": [ 1 ]}'

Удаление задачи

Описание: Этот запрос удаляет задачу с указанным идентификатором {id}. Убедитесь, что задача существует, перед отправкой запроса

Примечание

id*: идентификатор задачи, которую требуется удалить

Запрос:

DELETE /automation/api/job/{id}/

Ответ

204 The server successfully processed the request, but is not returning any content.

Пример:

curl --header "Authorization: Token [TOKEN]" --location --request DELETE "https://[SERVER_ADDR]/automation/api/job/123/"