Новая версия API v2

Информация для клиентов, которые помимо Личного кабинета работают с инфраструктурой через API — инструмент для управления услугами через HTTP-запросы.

Вышла вторая версия API. Документация на сайте: clo.ru/api — в шапке выбрать v2.

Версия v2 является основной. Версия v1 станет недоступна после 30 мая. Настоятельно рекомендуем перейти на API v2 до этой даты.

Об изменениях в API:

У многих методов поменялся эндпоинт и формат ответа. Если используете метод из подробного списка ниже, проверьте на соответствие v2.
В ответах на запросы уменьшилась глубина вложенности. Т.е. ответы по возможности сделаны «плоскими» списками.
Убрали из ответов объект links со ссылками на сущности.
Убрали из ответов параметры code и title: "code": 200, "title": "OK". Используйте коды ответа
Ответы по возможности обернуты в объект result. Изменен спеллинг: results → result

Подробный список того, что изменилось в версии 2 по сравнению с версией 1:

Проект:

GET /v2/projects - формат ответа
GET /v2/projects/{object_id}/networks - новый метод
GET /v2/projects/{project_id}/images  - формат ответа (results → result)
GET /v2/projects/{object_id}/limits   - формат ответа (results → result)

Внешние IP-адреса:

POST /v2/addresses/{address_id}/attach   - формат ответа (отсутствует)
POST /v2/addresses/{address_id}/detach   - формат ответа (отсутствует)
POST /v2/addresses/{address_id}/primary  - формат ответа (отсутствует)
GET  /v2/addresses/{object_id}/detail    - формат ответа, удален объект links
GET  /v2/projects/{project_id}/addresses - формат ответа, удалены объекты links
POST /v2/projects/{object_id}/addresses  - формат ответа

Рецепты:

GET /v1/recipes → /v2/projects/{object_id}/recipes - эндпоинт, параметры запроса и формат ответа

Объектное хранилище S3:

GET    /v1/projects/{project_id}/s3_users →
       /v2/projects/{object_id}/s3/users    - эндпоинт
	   
POST   /v2/projects/{object_id}/s3/users    - формат ответа

DELETE /v1/s3_users/{s3_user_id} →
       /v2/s3/users/{object_id}             - эндпоинт
	   
GET    /v1/s3_users/{s3_user_id} →
       /v2/s3/users/{object_id}/detail      - эндпоинт
	   
GET    /v1/s3_users/{s3_user_id}/keys →
       /v2/s3/users/{object_id}/credentials - эндпоинт и формат ответа
	   
POST   /v1/s3_users/{s3_user_id}/keys →
       /v2/s3/users/{object_id}/credentials - эндпоинт и формат ответа
	   
PATCH  /v1/s3_users/{s3_user_id} →
       /v2/s3/users/{object_id}             - эндпоинт и формат ответа (отсутствует)
	   
PATCH  /v1/s3_users/{s3_user_id}/quotas →
       /v2/s3/users/{object_id}/quotas      - эндпоинт и формат ответа (отсутствует)
	   
POST   /v1/s3_users/{s3_user_id}/suspend →
       /v2/s3/users/{object_id}/suspend     - эндпоинт и формат ответа (отсутствует)
	   
POST   /v1/s3_users/{s3_user_id}/unsuspend →
       /v2/s3/users/{object_id}/unsuspend   - эндпоинт и формат ответа (отсутствует)

Серверы:

GET  /v2/projects/{object_id}/servers - формат ответа
POST /v2/projects/{object_id}/servers - формат ответа
GET  /v2/servers/{object_id}/detail   - формат ответа
GET  /v2/servers/{object_id}/licenses - формат ответа (results → result)
PUT  /v1/servers/{server_id}/ptr      - удален, действие доступно у IP
POST /v2/servers/{object_id}/reboot   - параметры запроса

Диски:

GET  /v2/local-disks/{object_id}/detail    - формат ответа
GET  /v2/projects/{object_id}/local-disks  - формат ответа
GET  /v2/projects/{object_id}/volumes      - формат ответа
POST /v2/projects/{object_id}/volumes      - параметры запроса и формат ответа (отутствует)
POST /v2/volumes/{object_id}/attach        - параметры запроса и формат ответа (отутствует)
GET  /v2/volumes/{object_id}/detail        - формат ответа
POST /v2/volumes/{object_id}/extend        - параметры запроса

Плавающие IP — все методы удалены. Смотри: Внешние IP-адреса:

POST   /v1/floatingips/{floating_id}/attach  - Удален
DELETE /v1/floatingips/{floating_id}         - Удален
POST   /v1/floatingips/{floating_id}/detach  - Удален
GET    /v1/floatingips/{floating_id}/detail  - Удален
PUT    /v1/floatingips/{floating_id}/ptr     - Удален
GET    /v1/projects/{project_id}/floatingips - Удален
POST   /v1/projects/{project_id}/floatingips - Удален

Лицензии:

GET  /v2/licenses/{object_id}           - новый метод
GET  /v2/licenses                       - формат ответа
POST /v2/servers/{object_id}/licenses   - формат ответа (появился)

Балансировщики нагрузки:

GET  /v2/loadbalancers/{object_id}/detail         - формат ответа
GET  /v2/loadbalancers/{object_id}/rules          - формат ответа
GET  /v2/projects/{object_id}/loadbalancers/rules - формат ответа
POST /v2/loadbalancers/{object_id}/rules          - параметры запроса и формат ответа
GET  /v2/loadbalancers/rules/{object_id}          - формат ответа
GET  /v2/projects/{object_id}/loadbalancers       - формат ответа
POST /v2/projects/{object_id}/loadbalancers       - формат ответа

Снапшоты:

GET    /v2/projects/{object_id}/snapshots                         - формат ответа
POST   /v2/servers/{object_id}/snapshot                           - формат ответа
DELETE /v1/snapshots/{snapshot_id}/delete → /v2/snapshots/{object_id}  - эндпоинт
GET    /v2/snapshots/{object_id}/detail                           - формат ответа
GET    /v2/snapshots/{object_id}/restore                          - параметры запроса и формат ответа

SSH-ключи:

DELETE /v1/keypairs/{keypair_id}/delete → /v2/keypairs/{object_id} - эндпоинт
POST   /v1/keypairs → /v2/projects/{object_id}/keypairs         - эндпоинт и параметры запроса
POST   /v2/projects/{object_id}/keypairs/generate               - новый метод
GET    /v1/keypairs → /v2/projects/{object_id}/keypairs         - эндпоинт и формат ответа (results → result)

Облачные базы данных:

GET   /v2/dbaas/backups/{object_id}                 - формат ответа
POST  /v2/dbaas/clusters/{object_id}/backup/create  - формат ответа
GET   /v2/dbaas/clusters/{object_id}/databases      - формат ответа
POST  /v2/dbaas/clusters/{object_id}/databases      - формат ответа
POST  /v2/dbaas/clusters/{object_id}/disable        - формат ответа (отсутствует)
POST  /v2/dbaas/clusters/{object_id}/enable         - формат ответа
GET   /v2/dbaas/clusters/{object_id}                - формат ответа
GET   /v2/dbaas/clusters/{object_id}/nodes          - формат ответа
PATCH /v2/dbaas/clusters/{object_id}                - формат ответа (отсутствует)
POST  /v2/dbaas/nodes/{object_id}/resize/storage    - формат ответа (отсутствует)
POST  /v2/dbaas/databases/{object_id}/backup/create - формат ответа
GET   /v2/dbaas/databases/{object_id}               - формат ответа
GET   /v2/dbaas/nodes/{object_id}                   - формат ответа
GET   /v2/projects/{object_id}/dbaas/backups        - формат ответа (results → result)
POST  /v2/projects/{object_id}/dbaas/clusters       - формат ответа
GET   /v2/projects/{object_id}/dbaas/datastores     - формат ответа (results → result)

Виртуальные роутеры:

GET   /v2/projects/{object_id}/vrouters  - формат ответа
POST  /v2/projects/{object_id}/vrouters  - формат ответа

База знаний

Новая версия API v2

Популярные вопросы

Продукты

Документация

Компания