ssh_keys.php¶

API для управления SSH-ключами пользователя: добавление, обновление, удаление и просмотр списка ключей

Методы API¶

Метод	Действие	Описание
`add`	добавление ключа	Добавляет новый SSH-ключ в профиль пользователя
`delete`	удаление ключа	Удаляет существующий SSH-ключ по его ID
`list`	получение списка ключей	Возвращает список всех SSH-ключей пользователя
`show`	просмотр ключа	Возвращает детальную информацию о конкретном SSH-ключе
`update`	обновление ключа	Обновляет данные существующего SSH-ключа

ssh_keys/add¶

Добавляет новый SSH-ключ в профиль пользователя

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
customer_id	❌	integer	ID клиента (используется администратором)

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

curl -s "https://invapi.hostkey.ru/ssh_keys.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "add",
"sshkey": {
"id": 123,
"name": "work_laptop",
"public_key": "ssh-rsa AAAAB3Nza...",
"created_at": "2024-05-20T12:00:00Z"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

ssh_keys/delete¶

Удаляет существующий SSH-ключ по его ID

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации
id	✅	integer	ID удаляемого SSH-ключа

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

curl -s "https://invapi.hostkey.ru/ssh_keys.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "delete",
"sshkey": {
"id": 123,
"status": "deleted"
}
}

Примеры ошибок

{
"code": -404,
"message": "Key not found"
}

ssh_keys/list¶

Возвращает список всех SSH-ключей пользователя

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
customer_id	❌	integer	Уникальный идентификатор клиента для получения списка его SSH-ключей.

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

curl -s "https://invapi.hostkey.ru/ssh_keys.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "list",
"sshkeys": [
{
"id": 1,
"name": "personal",
"public_key": "ssh-rsa AAAAB3Nza...",
"created_at": "2024-01-01T10:00:00Z"
},
{
"id": 2,
"name": "server_access",
"public_key": "ssh-rsa AAAAB3Nza...",
"created_at": "2024-02-15T15:30:00Z"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

ssh_keys/show¶

Возвращает детальную информацию о конкретном SSH-ключе

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `show`
token	✅	string	Токен авторизации
id	✅	integer	ID SSH-ключа

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

curl -s "https://invapi.hostkey.ru/ssh_keys.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "show",
"sshkey": {
"id": 123,
"name": "work_laptop",
"public_key": "ssh-rsa AAAAB3Nza...",
"created_at": "2024-05-20T12:00:00Z"
}
}

Примеры ошибок

{
"code": -404,
"message": "Key not found"
}

ssh_keys/update¶

Обновляет данные существующего SSH-ключа

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
id	✅	integer	ID SSH-ключа для обновления

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

curl -s "https://invapi.hostkey.ru/ssh_keys.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "update",
"sshkey": {
"id": 123,
"name": "updated_key",
"public_key": "ssh-rsa AAAAB3Nza...",
"updated_at": "2024-05-21T09:00:00Z"
}
}

Примеры ошибок

{
"code": -1,
"message": "Key not found"
}