/** * Timeweb Cloud API * # Введение API Timeweb Cloud позволяет вам управлять ресурсами в облаке программным способом с использованием обычных HTTP-запросов. Множество функций, которые доступны в панели управления Timeweb Cloud, также доступны через API, что позволяет вам автоматизировать ваши собственные сценарии. В этой документации сперва будет описан общий дизайн и принципы работы API, а после этого конкретные конечные точки. Также будут приведены примеры запросов к ним. ## Запросы Запросы должны выполняться по протоколу `HTTPS`, чтобы гарантировать шифрование транзакций. Поддерживаются следующие методы запроса: |Метод|Применение| |--- |--- | |GET|Извлекает данные о коллекциях и отдельных ресурсах.| |POST|Для коллекций создает новый ресурс этого типа. Также используется для выполнения действий с конкретным ресурсом.| |PUT|Обновляет существующий ресурс.| |PATCH|Некоторые ресурсы поддерживают частичное обновление, то есть обновление только части атрибутов ресурса, в этом случае вместо метода PUT будет использован PATCH.| |DELETE|Удаляет ресурс.| Методы `POST`, `PUT` и `PATCH` могут включать объект в тело запроса с типом содержимого `application/json`. ### Параметры в запросах Некоторые коллекции поддерживают пагинацию, поиск или сортировку в запросах. В параметрах запроса требуется передать: - `limit` — обозначает количество записей, которое необходимо вернуть - `offset` — указывает на смещение, относительно начала списка - `search` — позволяет указать набор символов для поиска - `sort` — можно задать правило сортировки коллекции ## Ответы Запросы вернут один из следующих кодов состояния ответа HTTP: |Статус|Описание| |--- |--- | |200 OK|Действие с ресурсом было выполнено успешно.| |201 Created|Ресурс был успешно создан. При этом ресурс может быть как уже готовым к использованию, так и находиться в процессе запуска.| |204 No Content|Действие с ресурсом было выполнено успешно, и ответ не содержит дополнительной информации в теле.| |400 Bad Request|Был отправлен неверный запрос, например, в нем отсутствуют обязательные параметры и т. д. Тело ответа будет содержать дополнительную информацию об ошибке.| |401 Unauthorized|Ошибка аутентификации.| |403 Forbidden|Аутентификация прошла успешно, но недостаточно прав для выполнения действия.| |404 Not Found|Запрашиваемый ресурс не найден.| |409 Conflict|Запрос конфликтует с текущим состоянием.| |423 Locked|Ресурс из запроса заблокирован от применения к нему указанного метода.| |429 Too Many Requests|Был достигнут лимит по количеству запросов в единицу времени.| |500 Internal Server Error|При выполнении запроса произошла какая-то внутренняя ошибка. Чтобы решить эту проблему, лучше всего создать тикет в панели управления.| ### Структура успешного ответа Все конечные точки будут возвращать данные в формате `JSON`. Ответы на `GET`-запросы будут иметь на верхнем уровне следующую структуру атрибутов: |Название поля|Тип|Описание| |--- |--- |--- | |[entity_name]|object, object[], string[], number[], boolean|Динамическое поле, которое будет меняться в зависимости от запрашиваемого ресурса и будет содержать все атрибуты, необходимые для описания этого ресурса. Например, при запросе списка баз данных будет возвращаться поле `dbs`, а при запросе конкретного облачного сервера `server`. Для некоторых конечных точек в ответе может возвращаться сразу несколько ресурсов.| |meta|object|Опционально. Объект, который содержит вспомогательную информацию о ресурсе. Чаще всего будет встречаться при запросе коллекций и содержать поле `total`, которое будет указывать на количество элементов в коллекции.| |response_id|string|Опционально. В большинстве случаев в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID— так мы сможем найти ответ на него намного быстрее. Также вы можете использовать этот ID, чтобы убедиться, что это новый ответ на запрос и результат не был получен из кэша.| Пример запроса на получение списка SSH-ключей: ``` HTTP/2.0 200 OK { \"ssh_keys\":[ { \"body\":\"ssh-rsa AAAAB3NzaC1sdfghjkOAsBwWhs= example@device.local\", \"created_at\":\"2021-09-15T19:52:27Z\", \"expired_at\":null, \"id\":5297, \"is_default\":false, \"name\":\"example@device.local\", \"used_at\":null, \"used_by\":[] } ], \"meta\":{ \"total\":1 }, \"response_id\":\"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\" } ``` ### Структура ответа с ошибкой |Название поля|Тип|Описание| |--- |--- |--- | |status_code|number|Короткий числовой идентификатор ошибки.| |error_code|string|Короткий текстовый идентификатор ошибки, который уточняет числовой идентификатор и удобен для программной обработки. Самый простой пример — это код `not_found` для ошибки 404.| |message|string, string[]|Опционально. В большинстве случаев в ответе будет содержаться человекочитаемое подробное описание ошибки или ошибок, которые помогут понять, что нужно исправить.| |response_id|string|Опционально. В большинстве случае в ответе будет содержаться ID ответа в формате UUIDv4, который однозначно указывает на ваш запрос внутри нашей системы. Если вам потребуется задать вопрос нашей поддержке, приложите к вопросу этот ID — так мы сможем найти ответ на него намного быстрее.| Пример: ``` HTTP/2.0 403 Forbidden { \"status_code\": 403, \"error_code\": \"forbidden\", \"message\": \"You do not have access for the attempted action\", \"response_id\": \"94608d15-8672-4eed-8ab6-28bd6fa3cdf7\" } ``` ## Статусы ресурсов Важно учесть, что при создании большинства ресурсов внутри платформы вам будет сразу возвращен ответ от сервера со статусом `200 OK` или `201 Created` и ID созданного ресурса в теле ответа, но при этом этот ресурс может быть ещё в *состоянии запуска*. Для того чтобы понять, в каком состоянии сейчас находится ваш ресурс, мы добавили поле `status` в ответ на получение информации о ресурсе. Список статусов будет отличаться в зависимости от типа ресурса. Увидеть поддерживаемый список статусов вы сможете в описании каждого конкретного ресурса. ## Ограничение скорости запросов (Rate Limiting) Чтобы обеспечить стабильность для всех пользователей, Timeweb Cloud защищает API от всплесков входящего трафика, анализируя количество запросов c каждого аккаунта к каждой конечной точке. Если ваше приложение отправляет более 20 запросов в секунду на одну конечную точку, то для этого запроса API может вернуть код состояния HTTP `429 Too Many Requests`. ## Аутентификация Доступ к API осуществляется с помощью JWT-токена. Токенами можно управлять внутри панели управления Timeweb Cloud в разделе *API и Terraform*. Токен необходимо передавать в заголовке каждого запроса в формате: ``` Authorization: Bearer $TIMEWEB_CLOUD_TOKEN ``` ## Формат примеров API Примеры в этой документации описаны с помощью `curl`, HTTP-клиента командной строки. На компьютерах `Linux` и `macOS` обычно по умолчанию установлен `curl`, и он доступен для загрузки на всех популярных платформах, включая `Windows`. Каждый пример разделен на несколько строк символом `\\`, который совместим с `bash`. Типичный пример выглядит так: ``` curl -X PATCH -H \"Content-Type: application/json\" -H \"Authorization: Bearer $TIMEWEB_CLOUD_TOKEN\" -d \'{\"name\":\"Cute Corvus\",\"comment\":\"Development Server\"}\' \"https://api.timeweb.cloud/api/v1/dedicated/1051\" ``` - Параметр `-X` задает метод запроса. Для согласованности метод будет указан во всех примерах, даже если он явно не требуется для методов `GET`. - Строки `-H` задают требуемые HTTP-заголовки. - Примеры, для которых требуется объект JSON в теле запроса, передают требуемые данные через параметр `-d`. Чтобы использовать приведенные примеры, не подставляя каждый раз в них свой токен, вы можете добавить токен один раз в переменные окружения в вашей консоли. Например, на `Linux` это можно сделать с помощью команды: ``` TIMEWEB_CLOUD_TOKEN=\"token\" ``` После этого токен будет автоматически подставляться в ваши запросы. Обратите внимание, что все значения в этой документации являются примерами. Не полагайтесь на IDы операционных систем, тарифов и т.д., используемые в примерах. Используйте соответствующую конечную точку для получения значений перед созданием ресурсов. ## Версионирование API построено согласно принципам [семантического версионирования](https://semver.org/lang/ru). Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии. Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос `/api/v1/servers` указывает, что этот метод имеет версию 1. * * The version of the OpenAPI document: 1.0.0 * Contact: info@timeweb.cloud * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AddGithub, AddProvider201Response, AppsPresets, AvailableFrameworks, CreateApp, CreateApp201Response, CreateDeploy201Response, CreateDeployRequest, GetAppDeploys200Response, GetAppLogs200Response, GetApps200Response, GetBranches200Response, GetCommits200Response, GetDeployLogs200Response, GetDeploySettings200Response, GetProviders200Response, GetRepositories200Response, GetServerStatistics200Response, UpdateAppSettings200Response, UpdateSettings } from '../models/index'; export interface AddProviderRequest { addGithub: AddGithub; } export interface CreateAppRequest { createApp: CreateApp; } export interface CreateDeployOperationRequest { appId: string; createDeployRequest: CreateDeployRequest; } export interface DeleteAppRequest { appId: string; } export interface DeleteProviderRequest { providerId: string; } export interface DeployActionRequest { appId: string; deployId: string; } export interface GetAppRequest { appId: string; } export interface GetAppDeploysRequest { appId: string; limit?: number; offset?: number; } export interface GetAppLogsRequest { appId: string; } export interface GetAppStatisticsRequest { appId: string; dateFrom: string; dateTo: string; } export interface GetAppsPresetsRequest { appId: string; } export interface GetBranchesRequest { providerId: string; repositoryId: string; } export interface GetCommitsRequest { accountId: string; providerId: string; repositoryId: string; name: string; } export interface GetDeployLogsRequest { appId: string; deployId: string; debug?: boolean; } export interface GetDeploySettingsRequest { appId: string; } export interface GetFrameworksRequest { appId: string; } export interface GetRepositoriesRequest { providerId: string; } export interface UpdateAppSettingsRequest { appId: string; updateSettings: UpdateSettings; } export interface UpdateAppStateRequest { appId: string; action: UpdateAppStateActionEnum; } /** * */ export declare class AppsApi extends runtime.BaseAPI { /** * Чтобы привязать аккаунт провайдера отправьте POST-запрос в `/api/v1/vcs-provider`, задав необходимые атрибуты. * Привязка vcs провайдера */ addProviderRaw(requestParameters: AddProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы привязать аккаунт провайдера отправьте POST-запрос в `/api/v1/vcs-provider`, задав необходимые атрибуты. * Привязка vcs провайдера */ addProvider(requestParameters: AddProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы создать приложение, отправьте POST-запрос в `/api/v1/apps`, задав необходимые атрибуты. * Создание приложения */ createAppRaw(requestParameters: CreateAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы создать приложение, отправьте POST-запрос в `/api/v1/apps`, задав необходимые атрибуты. * Создание приложения */ createApp(requestParameters: CreateAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы запустить деплой приложения, отправьте POST-запрос в `/api/v1/apps/{app_id}/deploy`, задав необходимые атрибуты. * Запуск деплоя приложения */ createDeployRaw(requestParameters: CreateDeployOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы запустить деплой приложения, отправьте POST-запрос в `/api/v1/apps/{app_id}/deploy`, задав необходимые атрибуты. * Запуск деплоя приложения */ createDeploy(requestParameters: CreateDeployOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы удалить приложение, отправьте DELETE-запрос в `/api/v1/apps/{app_id}`. * Удаление приложения */ deleteAppRaw(requestParameters: DeleteAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы удалить приложение, отправьте DELETE-запрос в `/api/v1/apps/{app_id}`. * Удаление приложения */ deleteApp(requestParameters: DeleteAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы отвязать vcs провайдера от аккаунта, отправьте DELETE-запрос в `/api/v1/vcs-provider/{provider_id}`. * Отвязка vcs провайдера от аккаунта */ deleteProviderRaw(requestParameters: DeleteProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы отвязать vcs провайдера от аккаунта, отправьте DELETE-запрос в `/api/v1/vcs-provider/{provider_id}`. * Отвязка vcs провайдера от аккаунта */ deleteProvider(requestParameters: DeleteProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы остановить деплой приложения, отправьте POST-запрос в `api/v1/apps/{app_id}/deploy/{deploy_id}/stop`. * Остановка деплоя приложения */ deployActionRaw(requestParameters: DeployActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы остановить деплой приложения, отправьте POST-запрос в `api/v1/apps/{app_id}/deploy/{deploy_id}/stop`. * Остановка деплоя приложения */ deployAction(requestParameters: DeployActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить приложение по id, отправьте GET-запрос на `/api/v1/apps/{app_id}`. * Получение приложения по id */ getAppRaw(requestParameters: GetAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить приложение по id, отправьте GET-запрос на `/api/v1/apps/{app_id}`. * Получение приложения по id */ getApp(requestParameters: GetAppRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список деплоев приложения, отправьте GET-запрос на `/api/v1/apps/{app_id}/deploys`. * Получение списка деплоев приложения */ getAppDeploysRaw(requestParameters: GetAppDeploysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список деплоев приложения, отправьте GET-запрос на `/api/v1/apps/{app_id}/deploys`. * Получение списка деплоев приложения */ getAppDeploys(requestParameters: GetAppDeploysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить логи приложения, отправьте GET-запрос на `/api/v1/apps/{app_id}/logs`. * Получение логов приложения */ getAppLogsRaw(requestParameters: GetAppLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить логи приложения, отправьте GET-запрос на `/api/v1/apps/{app_id}/logs`. * Получение логов приложения */ getAppLogs(requestParameters: GetAppLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить статистику сервера, отправьте GET-запрос на `/api/v1/apps/{app_id}/statistics`. Метод поддерживает только приложения `type: backend`. * Получение статистики приложения */ getAppStatisticsRaw(requestParameters: GetAppStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить статистику сервера, отправьте GET-запрос на `/api/v1/apps/{app_id}/statistics`. Метод поддерживает только приложения `type: backend`. * Получение статистики приложения */ getAppStatistics(requestParameters: GetAppStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список приложений, отправьте GET-запрос на `/api/v1/apps`. * Получение списка приложений */ getAppsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список приложений, отправьте GET-запрос на `/api/v1/apps`. * Получение списка приложений */ getApps(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список доступных тарифов, отправьте GET-запрос на `/api/v1/presets/apps`. * Получение списка доступных тарифов для приложения */ getAppsPresetsRaw(requestParameters: GetAppsPresetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список доступных тарифов, отправьте GET-запрос на `/api/v1/presets/apps`. * Получение списка доступных тарифов для приложения */ getAppsPresets(requestParameters: GetAppsPresetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список веток репозитория, отправьте GET-запрос на `/api/v1/vcs-provider/{provider_id}/repository/{repository_id}`. * Получение списка веток репозитория */ getBranchesRaw(requestParameters: GetBranchesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список веток репозитория, отправьте GET-запрос на `/api/v1/vcs-provider/{provider_id}/repository/{repository_id}`. * Получение списка веток репозитория */ getBranches(requestParameters: GetBranchesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список коммитов ветки репозитория, отправьте GET-запрос на `/api/v1/vcs-provider/{provider_id}/repository/{repository_id}/branch`. * Получение списка коммитов ветки репозитория */ getCommitsRaw(requestParameters: GetCommitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список коммитов ветки репозитория, отправьте GET-запрос на `/api/v1/vcs-provider/{provider_id}/repository/{repository_id}/branch`. * Получение списка коммитов ветки репозитория */ getCommits(requestParameters: GetCommitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить информацию о деплое, отправьте GET-запрос на `api/v1/apps/{app_id}/deploy/{deploy_id}/logs`. * Получение логов деплоя приложения */ getDeployLogsRaw(requestParameters: GetDeployLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить информацию о деплое, отправьте GET-запрос на `api/v1/apps/{app_id}/deploy/{deploy_id}/logs`. * Получение логов деплоя приложения */ getDeployLogs(requestParameters: GetDeployLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список настроек деплоя, отправьте GET-запрос на `/api/v1/deploy-settings/apps`. * Получение списка дефолтных настроек деплоя для приложения */ getDeploySettingsRaw(requestParameters: GetDeploySettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список настроек деплоя, отправьте GET-запрос на `/api/v1/deploy-settings/apps`. * Получение списка дефолтных настроек деплоя для приложения */ getDeploySettings(requestParameters: GetDeploySettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список доступных фреймворков, отправьте GET-запрос на `/api/v1/frameworks/apps`. * Получение списка доступных фреймворков для приложения */ getFrameworksRaw(requestParameters: GetFrameworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список доступных фреймворков, отправьте GET-запрос на `/api/v1/frameworks/apps`. * Получение списка доступных фреймворков для приложения */ getFrameworks(requestParameters: GetFrameworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список vcs провайдеров, отправьте GET-запрос на `/api/v1/vcs-provider`. * Получение списка vcs провайдеров */ getProvidersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список vcs провайдеров, отправьте GET-запрос на `/api/v1/vcs-provider`. * Получение списка vcs провайдеров */ getProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы получить список репозиториев vcs провайдера, отправьте GET-запрос на `/api/v1/vcs-provider/{provider_id}`. * Получение списка репозиториев vcs провайдера */ getRepositoriesRaw(requestParameters: GetRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы получить список репозиториев vcs провайдера, отправьте GET-запрос на `/api/v1/vcs-provider/{provider_id}`. * Получение списка репозиториев vcs провайдера */ getRepositories(requestParameters: GetRepositoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить настройки приложения отправьте PATCH-запрос в `/api/v1/apps/{app_id}`, задав необходимые атрибуты. * Изменение настроек приложения */ updateAppSettingsRaw(requestParameters: UpdateAppSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить настройки приложения отправьте PATCH-запрос в `/api/v1/apps/{app_id}`, задав необходимые атрибуты. * Изменение настроек приложения */ updateAppSettings(requestParameters: UpdateAppSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Чтобы изменить состояние приложения отправьте PATCH-запрос в `/api/v1/apps/{app_id}/action/{action}`, задав необходимые атрибуты. * Изменение состояния приложения */ updateAppStateRaw(requestParameters: UpdateAppStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Чтобы изменить состояние приложения отправьте PATCH-запрос в `/api/v1/apps/{app_id}/action/{action}`, задав необходимые атрибуты. * Изменение состояния приложения */ updateAppState(requestParameters: UpdateAppStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const UpdateAppStateActionEnum: { readonly Reboot: "reboot"; readonly Pause: "pause"; readonly Resume: "resume"; }; export type UpdateAppStateActionEnum = typeof UpdateAppStateActionEnum[keyof typeof UpdateAppStateActionEnum];