Cloud VDS

Список SSH-ключей

URL: /api/v1/cloud/vms/{id}/ssh/
Метод: GET
Результат: JSON

ВНИМАНИЕ! Данный метод выводит ключи только для указанной ВМ.
Тажке есть метод, позволяющий получить список всех ssh-ключей пользователя.
Он размещен в разделе SSH-ключи

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

Обязательные параметры:

  • id: int - ID виртуальной машины

Необязательные параметры:

  • offset: int - Индекс первой строки выборки, начиная с 0
  • limit: int - Количество элементов в выборке в диапазоне от 10 до 100

Коды ответов

Код Описание
200 Успешный запрос

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

curl --request GET 'https://api-ms.netangels.ru/api/v1/cloud/vms/{id}/ssh/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Загрузка нового SSH-ключа на ВМ

URL: /api/v1/cloud/vms/{id}/ssh/create/
Метод: POST
Результат: JSON

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

Обязательные параметры:

  • id: int - ID виртуальной машины

Параметры тела запроса

Обязательные параметры:

  • key: str - SSH-ключ

Необязательные параметры:

  • name: str - Имя SSH-ключа

Коды ответов

Код Описание
200 Успешный запрос
400 Неправильный или уже существующий SSH ключ

Возвращаемое значение

SSH-ключ

  • id: int - Идентификатор ключа.
  • name: str - Имя ключа.
  • key: str - Ключ типа ssh-rsa или ssh-dss.
  • created: datetime - Дата создания ключа.
  • updated: datetime - Дата изменения ключа.
  • fingerprint: str - Отпечаток ssh-ключа.

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

curl --request POST 'https://api-ms.netangels.ru/api/v1/cloud/vms/{id}/ssh/create/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "key": "ssh-rsa Hridf9...jstJFHE user@laptop" 
    }'

Загрузка существующего SSH-ключа на ВМ

URL: /api/v1/cloud/vms/{id}/ssh/upload/
Метод: POST
Результат: JSON

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

Обязательные параметры:

  • id: int - ID виртуальной машины

Параметры тела запроса

Обязательные параметры:

  • key_id: int - Идентификатор ключа

Коды ответов

Код Описание
200 Успешный запрос
404 Не найден SSH ключ
400 Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

SSH-ключ

  • id: int - Идентификатор ключа.
  • name: str - Имя ключа.
  • key: str - Ключ типа ssh-rsa или ssh-dss.
  • created: datetime - Дата создания ключа.
  • updated: datetime - Дата изменения ключа.
  • fingerprint: str - Отпечаток ssh-ключа.

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

curl --request POST 'https://api-ms.netangels.ru/api/v1/cloud/vms/{id}/ssh/upload/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "key_id": 12 
    }'

Удаление SSH-ключа с ВМ

URL: /api/v1/cloud/vms/{id}/ssh/{key_id}/
Метод: DELETE
Результат: JSON

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

Обязательные параметры:

  • id: int - ID виртуальной машины
  • key_id: int - ID SSH-ключ

Коды ответов

Код Описание
200 Успешный запрос
404 Ключ или ВМ не найден

Возвращаемое значение

SSH-ключ

  • id: int - Идентификатор ключа.
  • name: str - Имя ключа.
  • key: str - Ключ типа ssh-rsa или ssh-dss.
  • created: datetime - Дата создания ключа.
  • updated: datetime - Дата изменения ключа.
  • fingerprint: str - Отпечаток ssh-ключа.

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

curl --request DELETE 'https://api-ms.netangels.ru/api/v1/cloud/vms/{id}/ssh/{key_id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"