Перейти к содержанию

jenkins.php

Модуль интеграции с Jenkins для управления задачами автоматизации на серверах

Методы API

Метод Действие Описание
call вызов задачи Jenkins Запускает выполнение конкретной задачи Jenkins для указанного сервера с возможностью передачи дополнительных параметров.
get_tasks получение списка задач Возвращает список всех доступных задач Jenkins для текущего пользователя или администратора.

jenkins/get_tasks

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: get_tasks
token ❌ string Токен авторизации для проверки прав доступа.

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

curl -s "https://invapi.hostkey.ru/jenkins.php" -X POST \
--data "action=get_tasks"
Пример успешного ответа
{
"result": "OK",
"tasks": [
{
"id": 123,
"task": "reinstall_os",
"name": "Reinstall OS"
}
]
}
Примеры ошибок
{
"code": -2,
"message": "Invalid hash"
}

jenkins/call

Запускает выполнение конкретной задачи Jenkins для указанного сервера с возможностью передачи дополнительных параметров.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: call
token ❌ string Токен авторизации.
id ✅ integer ID сервера (обязателен для выполнения операций над конкретным хостом).
task ✅ string integer
extra ❌ object Дополнительные параметры для передачи в Jenkins в формате JSON.

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

curl -s "https://invapi.hostkey.ru/jenkins.php" -X POST \
--data "action=call" \
--data "id=123" \
--data "task=my_job_name" \
--data "extra={\"param\": \"value\"}"
Пример успешного ответа
{
"result": "OK",
"action": "call",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}
Примеры ошибок
{
"code": -1,
"message": "Unknown jenkins task name task",
"details": {
"id": 123
}
}
question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×