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= [email protected]\",
\"created_at\":\"2021-09-15T19:52:27Z\",
\"expired_at\":null,
\"id\":5297,
\"is_default\":false,
\"name\":\"[email protected]\",
\"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 в ответ на получение информации о ресурсе.
Список статусов будет отличаться в зависимости от типа ресурса. Увидеть поддерживаемый список статусов вы сможете в описании каждого конкретного ресурса.
Чтобы обеспечить стабильность для всех пользователей, Timeweb Cloud защищает API от всплесков входящего трафика, анализируя количество запросов c каждого аккаунта к каждой конечной точке.
Если ваше приложение отправляет более 20 запросов в секунду на одну конечную точку, то для этого запроса API может вернуть код состояния HTTP 429 Too Many Requests.
Доступ к API осуществляется с помощью JWT-токена. Токенами можно управлять внутри панели управления Timeweb Cloud в разделе API и Terraform.
Токен необходимо передавать в заголовке каждого запроса в формате:
Authorization: Bearer $TIMEWEB_CLOUD_TOKEN
Примеры в этой документации описаны с помощью 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 построено согласно принципам семантического версионирования. Это значит, что мы гарантируем обратную совместимость всех изменений в пределах одной мажорной версии.
Мажорная версия каждой конечной точки обозначается в пути запроса, например, запрос /api/v1/servers указывает, что этот метод имеет версию 1.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/contextPut the package under your project folder and add the following in import:
import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"To use a proxy, set the environment variable HTTP_PROXY:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})Note, enum values are always validated and all unused variables are silently ignored.
Each operation can use different server URL defined using OperationServers map in the Configuration.
An operation is uniquely identified by "{classname}Service.{nickname}" string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})All URIs are relative to https://api.timeweb.cloud
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AIAgentsAPI | AddAdditionalTokenPackage | Post /api/v1/cloud-ai/agents/{id}/add-additional-token-package | Добавление дополнительного пакета токенов |
| AIAgentsAPI | CreateAgent | Post /api/v1/cloud-ai/agents | Создание AI агента |
| AIAgentsAPI | DeleteAgent | Delete /api/v1/cloud-ai/agents/{id} | Удаление AI агента |
| AIAgentsAPI | GetAgent | Get /api/v1/cloud-ai/agents/{id} | Получение AI агента |
| AIAgentsAPI | GetAgentStatistics | Get /api/v1/cloud-ai/agents/{id}/statistic | Получение статистики использования токенов агента |
| AIAgentsAPI | GetAgents | Get /api/v1/cloud-ai/agents | Получение списка AI агентов |
| AIAgentsAPI | UpdateAgent | Patch /api/v1/cloud-ai/agents/{id} | Обновление AI агента |
| APIKeysAPI | CreateToken | Post /api/v1/auth/api-keys | Создание токена |
| APIKeysAPI | DeleteToken | Delete /api/v1/auth/api-keys/{token_id} | Удалить токен |
| APIKeysAPI | GetTokens | Get /api/v1/auth/api-keys | Получение списка выпущенных токенов |
| APIKeysAPI | ReissueToken | Put /api/v1/auth/api-keys/{token_id} | Перевыпустить токен |
| APIKeysAPI | UpdateToken | Patch /api/v1/auth/api-keys/{token_id} | Изменить токен |
| AccountAPI | AddCountriesToAllowedList | Post /api/v1/auth/access/countries | Добавление стран в список разрешенных |
| AccountAPI | AddIPsToAllowedList | Post /api/v1/auth/access/ips | Добавление IP-адресов в список разрешенных |
| AccountAPI | DeleteCountriesFromAllowedList | Delete /api/v1/auth/access/countries | Удаление стран из списка разрешенных |
| AccountAPI | DeleteIPsFromAllowedList | Delete /api/v1/auth/access/ips | Удаление IP-адресов из списка разрешенных |
| AccountAPI | GetAccountStatus | Get /api/v1/account/status | Получение статуса аккаунта |
| AccountAPI | GetAuthAccessSettings | Get /api/v1/auth/access | Получить информацию о ограничениях авторизации пользователя |
| AccountAPI | GetCountries | Get /api/v1/auth/access/countries | Получение списка стран |
| AccountAPI | GetNotificationSettings | Get /api/v1/account/notification-settings | Получение настроек уведомлений аккаунта |
| AccountAPI | UpdateAuthRestrictionsByCountries | Post /api/v1/auth/access/countries/enabled | Включение/отключение ограничений по стране |
| AccountAPI | UpdateAuthRestrictionsByIP | Post /api/v1/auth/access/ips/enabled | Включение/отключение ограничений по IP-адресу |
| AccountAPI | UpdateNotificationSettings | Patch /api/v1/account/notification-settings | Изменение настроек уведомлений аккаунта |
| AppsAPI | AddProvider | Post /api/v1/vcs-provider | Привязка vcs провайдера |
| AppsAPI | CreateApp | Post /api/v1/apps | Создание приложения |
| AppsAPI | CreateDeploy | Post /api/v1/apps/{app_id}/deploy | Запуск деплоя приложения |
| AppsAPI | DeleteApp | Delete /api/v1/apps/{app_id} | Удаление приложения |
| AppsAPI | DeleteProvider | Delete /api/v1/vcs-provider/{provider_id} | Отвязка vcs провайдера от аккаунта |
| AppsAPI | DeployAction | Post /api/v1/apps/{app_id}/deploy/{deploy_id}/stop | Остановка деплоя приложения |
| AppsAPI | GetApp | Get /api/v1/apps/{app_id} | Получение приложения по id |
| AppsAPI | GetAppDeploys | Get /api/v1/apps/{app_id}/deploys | Получение списка деплоев приложения |
| AppsAPI | GetAppLogs | Get /api/v1/apps/{app_id}/logs | Получение логов приложения |
| AppsAPI | GetAppStatistics | Get /api/v1/apps/{app_id}/statistics | Получение статистики приложения |
| AppsAPI | GetApps | Get /api/v1/apps | Получение списка приложений |
| AppsAPI | GetAppsPresets | Get /api/v1/presets/apps | Получение списка доступных тарифов для приложения |
| AppsAPI | GetBranches | Get /api/v1/vcs-provider/{provider_id}/repository/{repository_id} | Получение списка веток репозитория |
| AppsAPI | GetCommits | Get /api/v1/vcs-provider/{provider_id}/repository/{repository_id}/branch | Получение списка коммитов ветки репозитория |
| AppsAPI | GetDeployLogs | Get /api/v1/apps/{app_id}/deploy/{deploy_id}/logs | Получение логов деплоя приложения |
| AppsAPI | GetDeploySettings | Get /api/v1/deploy-settings/apps | Получение списка дефолтных настроек деплоя для приложения |
| AppsAPI | GetFrameworks | Get /api/v1/frameworks/apps | Получение списка доступных фреймворков для приложения |
| AppsAPI | GetProviders | Get /api/v1/vcs-provider | Получение списка vcs провайдеров |
| AppsAPI | GetRepositories | Get /api/v1/vcs-provider/{provider_id} | Получение списка репозиториев vcs провайдера |
| AppsAPI | UpdateAppSettings | Patch /api/v1/apps/{app_id} | Изменение настроек приложения |
| AppsAPI | UpdateAppState | Patch /api/v1/apps/{app_id}/action/{action} | Изменение состояния приложения |
| BalancersAPI | AddIPsToBalancer | Post /api/v1/balancers/{balancer_id}/ips | Добавление IP-адресов к балансировщику |
| BalancersAPI | CreateBalancer | Post /api/v1/balancers | Создание бaлансировщика |
| BalancersAPI | CreateBalancerRule | Post /api/v1/balancers/{balancer_id}/rules | Создание правила для балансировщика |
| BalancersAPI | DeleteBalancer | Delete /api/v1/balancers/{balancer_id} | Удаление балансировщика |
| BalancersAPI | DeleteBalancerRule | Delete /api/v1/balancers/{balancer_id}/rules/{rule_id} | Удаление правила для балансировщика |
| BalancersAPI | DeleteIPsFromBalancer | Delete /api/v1/balancers/{balancer_id}/ips | Удаление IP-адресов из балансировщика |
| BalancersAPI | GetBalancer | Get /api/v1/balancers/{balancer_id} | Получение бaлансировщика |
| BalancersAPI | GetBalancerIPs | Get /api/v1/balancers/{balancer_id}/ips | Получение списка IP-адресов балансировщика |
| BalancersAPI | GetBalancerRules | Get /api/v1/balancers/{balancer_id}/rules | Получение правил балансировщика |
| BalancersAPI | GetBalancers | Get /api/v1/balancers | Получение списка всех бaлансировщиков |
| BalancersAPI | GetBalancersPresets | Get /api/v1/presets/balancers | Получение списка тарифов для балансировщика |
| BalancersAPI | UpdateBalancer | Patch /api/v1/balancers/{balancer_id} | Обновление балансировщика |
| BalancersAPI | UpdateBalancerRule | Patch /api/v1/balancers/{balancer_id}/rules/{rule_id} | Обновление правила для балансировщика |
| ContainerRegistryAPI | CreateRegistry | Post /api/v1/container-registry | Создание реестра |
| ContainerRegistryAPI | DeleteRegistry | Delete /api/v1/container-registry/{registry_id} | Удаление реестра |
| ContainerRegistryAPI | GetRegistries | Get /api/v1/container-registry | Получение списка реестров контейнеров |
| ContainerRegistryAPI | GetRegistry | Get /api/v1/container-registry/{registry_id} | Получение информации о реестре |
| ContainerRegistryAPI | GetRegistryPresets | Get /api/v1/container-registry/presets | Получение списка тарифов |
| ContainerRegistryAPI | GetRegistryRepositories | Get /api/v1/container-registry/{registry_id}/repositories | Получение списка репозиториев |
| ContainerRegistryAPI | UpdateRegistry | Patch /api/v1/container-registry/{registry_id} | Обновление информации о реестре |
| DatabasesAPI | CreateDatabase | Post /api/v1/dbs | Создание базы данных |
| DatabasesAPI | CreateDatabaseBackup | Post /api/v1/dbs/{db_id}/backups | Создание бэкапа базы данных |
| DatabasesAPI | CreateDatabaseCluster | Post /api/v1/databases | Создание кластера базы данных |
| DatabasesAPI | CreateDatabaseInstance | Post /api/v1/databases/{db_cluster_id}/instances | Создание инстанса базы данных |
| DatabasesAPI | CreateDatabaseUser | Post /api/v1/databases/{db_cluster_id}/admins | Создание пользователя базы данных |
| DatabasesAPI | DeleteDatabase | Delete /api/v1/dbs/{db_id} | Удаление базы данных |
| DatabasesAPI | DeleteDatabaseBackup | Delete /api/v1/dbs/{db_id}/backups/{backup_id} | Удаление бэкапа базы данных |
| DatabasesAPI | DeleteDatabaseCluster | Delete /api/v1/databases/{db_cluster_id} | Удаление кластера базы данных |
| DatabasesAPI | DeleteDatabaseInstance | Delete /api/v1/databases/{db_cluster_id}/instances/{instance_id} | Удаление инстанса базы данных |
| DatabasesAPI | DeleteDatabaseUser | Delete /api/v1/databases/{db_cluster_id}/admins/{admin_id} | Удаление пользователя базы данных |
| DatabasesAPI | GetDatabase | Get /api/v1/dbs/{db_id} | Получение базы данных |
| DatabasesAPI | GetDatabaseAutoBackupsSettings | Get /api/v1/dbs/{db_id}/auto-backups | Получение настроек автобэкапов базы данных |
| DatabasesAPI | GetDatabaseBackup | Get /api/v1/dbs/{db_id}/backups/{backup_id} | Получение бэкапа базы данных |
| DatabasesAPI | GetDatabaseBackups | Get /api/v1/dbs/{db_id}/backups | Список бэкапов базы данных |
| DatabasesAPI | GetDatabaseCluster | Get /api/v1/databases/{db_cluster_id} | Получение кластера базы данных |
| DatabasesAPI | GetDatabaseClusterTypes | Get /api/v1/database-types | Получение списка типов кластеров баз данных |
| DatabasesAPI | GetDatabaseClusters | Get /api/v1/databases | Получение списка кластеров баз данных |
| DatabasesAPI | GetDatabaseInstance | Get /api/v1/databases/{db_cluster_id}/instances/{instance_id} | Получение инстанса базы данных |
| DatabasesAPI | GetDatabaseInstances | Get /api/v1/databases/{db_cluster_id}/instances | Получение списка инстансов баз данных |
| DatabasesAPI | GetDatabaseParameters | Get /api/v1/dbs/parameters | Получение списка параметров баз данных |
| DatabasesAPI | GetDatabaseUser | Get /api/v1/databases/{db_cluster_id}/admins/{admin_id} | Получение пользователя базы данных |
| DatabasesAPI | GetDatabaseUsers | Get /api/v1/databases/{db_cluster_id}/admins | Получение списка пользователей базы данных |
| DatabasesAPI | GetDatabases | Get /api/v1/dbs | Получение списка всех баз данных |
| DatabasesAPI | GetDatabasesPresets | Get /api/v1/presets/dbs | Получение списка тарифов для баз данных |
| DatabasesAPI | RestoreDatabaseFromBackup | Put /api/v1/dbs/{db_id}/backups/{backup_id} | Восстановление базы данных из бэкапа |
| DatabasesAPI | UpdateDatabase | Patch /api/v1/dbs/{db_id} | Обновление базы данных |
| DatabasesAPI | UpdateDatabaseAutoBackupsSettings | Patch /api/v1/dbs/{db_id}/auto-backups | Изменение настроек автобэкапов базы данных |
| DatabasesAPI | UpdateDatabaseCluster | Patch /api/v1/databases/{db_cluster_id} | Изменение кластера базы данных |
| DatabasesAPI | UpdateDatabaseInstance | Patch /api/v1/databases/{db_cluster_id}/instances/{instance_id} | Изменение инстанса базы данных |
| DatabasesAPI | UpdateDatabaseUser | Patch /api/v1/databases/{db_cluster_id}/admins/{admin_id} | Изменение пользователя базы данных |
| DedicatedServersAPI | CreateDedicatedServer | Post /api/v1/dedicated-servers | Создание выделенного сервера |
| DedicatedServersAPI | DeleteDedicatedServer | Delete /api/v1/dedicated-servers/{dedicated_id} | Удаление выделенного сервера |
| DedicatedServersAPI | GetDedicatedServer | Get /api/v1/dedicated-servers/{dedicated_id} | Получение выделенного сервера |
| DedicatedServersAPI | GetDedicatedServerPresetAdditionalServices | Get /api/v1/presets/dedicated-servers/{preset_id}/additional-services | Получение дополнительных услуг для выделенного сервера |
| DedicatedServersAPI | GetDedicatedServers | Get /api/v1/dedicated-servers | Получение списка выделенных серверов |
| DedicatedServersAPI | GetDedicatedServersPresets | Get /api/v1/presets/dedicated-servers | Получение списка тарифов для выделенного сервера |
| DedicatedServersAPI | UpdateDedicatedServer | Patch /api/v1/dedicated-servers/{dedicated_id} | Обновление выделенного сервера |
| DomainsAPI | AddDomain | Post /api/v1/add-domain/{fqdn} | Добавление домена на аккаунт |
| DomainsAPI | AddSubdomain | Post /api/v1/domains/{fqdn}/subdomains/{subdomain_fqdn} | Добавление поддомена |
| DomainsAPI | CheckDomain | Get /api/v1/check-domain/{fqdn} | Проверить, доступен ли домен для регистрации |
| DomainsAPI | CreateDomainDNSRecord | Post /api/v1/domains/{fqdn}/dns-records | Добавить информацию о DNS-записи для домена или поддомена |
| DomainsAPI | CreateDomainRequest | Post /api/v1/domains-requests | Создание заявки на регистрацию/продление/трансфер домена |
| DomainsAPI | DeleteDomain | Delete /api/v1/domains/{fqdn} | Удаление домена |
| DomainsAPI | DeleteDomainDNSRecord | Delete /api/v1/domains/{fqdn}/dns-records/{record_id} | Удалить информацию о DNS-записи для домена или поддомена |
| DomainsAPI | DeleteSubdomain | Delete /api/v1/domains/{fqdn}/subdomains/{subdomain_fqdn} | Удаление поддомена |
| DomainsAPI | GetDomain | Get /api/v1/domains/{fqdn} | Получение информации о домене |
| DomainsAPI | GetDomainDNSRecords | Get /api/v1/domains/{fqdn}/dns-records | Получить информацию обо всех пользовательских DNS-записях домена или поддомена |
| DomainsAPI | GetDomainDefaultDNSRecords | Get /api/v1/domains/{fqdn}/default-dns-records | Получить информацию обо всех DNS-записях по умолчанию домена или поддомена |
| DomainsAPI | GetDomainNameServers | Get /api/v1/domains/{fqdn}/name-servers | Получение списка name-серверов домена |
| DomainsAPI | GetDomainRequest | Get /api/v1/domains-requests/{request_id} | Получение заявки на регистрацию/продление/трансфер домена |
| DomainsAPI | GetDomainRequests | Get /api/v1/domains-requests | Получение списка заявок на регистрацию/продление/трансфер домена |
| DomainsAPI | GetDomains | Get /api/v1/domains | Получение списка всех доменов |
| DomainsAPI | GetTLD | Get /api/v1/tlds/{tld_id} | Получить информацию о доменной зоне по ID |
| DomainsAPI | GetTLDs | Get /api/v1/tlds | Получить информацию о доменных зонах |
| DomainsAPI | UpdateDomainAutoProlongation | Patch /api/v1/domains/{fqdn} | Включение/выключение автопродления домена |
| DomainsAPI | UpdateDomainDNSRecord | Patch /api/v1/domains/{fqdn}/dns-records/{record_id} | Обновить информацию о DNS-записи домена или поддомена |
| DomainsAPI | UpdateDomainNameServers | Put /api/v1/domains/{fqdn}/name-servers | Изменение name-серверов домена |
| DomainsAPI | UpdateDomainRequest | Patch /api/v1/domains-requests/{request_id} | Оплата/обновление заявки на регистрацию/продление/трансфер домена |
| FirewallAPI | AddResourceToGroup | Post /api/v1/firewall/groups/{group_id}/resources/{resource_id} | Линковка ресурса в firewall group |
| FirewallAPI | CreateGroup | Post /api/v1/firewall/groups | Создание группы правил |
| FirewallAPI | CreateGroupRule | Post /api/v1/firewall/groups/{group_id}/rules | Создание firewall правила |
| FirewallAPI | DeleteGroup | Delete /api/v1/firewall/groups/{group_id} | Удаление группы правил |
| FirewallAPI | DeleteGroupRule | Delete /api/v1/firewall/groups/{group_id}/rules/{rule_id} | Удаление firewall правила |
| FirewallAPI | DeleteResourceFromGroup | Delete /api/v1/firewall/groups/{group_id}/resources/{resource_id} | Отлинковка ресурса из firewall group |
| FirewallAPI | GetGroup | Get /api/v1/firewall/groups/{group_id} | Получение информации о группе правил |
| FirewallAPI | GetGroupResources | Get /api/v1/firewall/groups/{group_id}/resources | Получение слинкованных ресурсов |
| FirewallAPI | GetGroupRule | Get /api/v1/firewall/groups/{group_id}/rules/{rule_id} | Получение информации о правиле |
| FirewallAPI | GetGroupRules | Get /api/v1/firewall/groups/{group_id}/rules | Получение списка правил |
| FirewallAPI | GetGroups | Get /api/v1/firewall/groups | Получение групп правил |
| FirewallAPI | GetRulesForResource | Get /api/v1/firewall/service/{resource_type}/{resource_id} | Получение групп правил для ресурса |
| FirewallAPI | UpdateGroup | Patch /api/v1/firewall/groups/{group_id} | Обновление группы правил |
| FirewallAPI | UpdateGroupRule | Patch /api/v1/firewall/groups/{group_id}/rules/{rule_id} | Обновление firewall правила |
| FloatingIPAPI | BindFloatingIp | Post /api/v1/floating-ips/{floating_ip_id}/bind | Привязать IP к сервису |
| FloatingIPAPI | CreateFloatingIp | Post /api/v1/floating-ips | Создание плавающего IP |
| FloatingIPAPI | DeleteFloatingIP | Delete /api/v1/floating-ips/{floating_ip_id} | Удаление плавающего IP по ID |
| FloatingIPAPI | GetFloatingIp | Get /api/v1/floating-ips/{floating_ip_id} | Получение плавающего IP |
| FloatingIPAPI | GetFloatingIps | Get /api/v1/floating-ips | Получение списка плавающих IP |
| FloatingIPAPI | UnbindFloatingIp | Post /api/v1/floating-ips/{floating_ip_id}/unbind | Отвязать IP от сервиса |
| FloatingIPAPI | UpdateFloatingIP | Patch /api/v1/floating-ips/{floating_ip_id} | Изменение плавающего IP по ID |
| ImagesAPI | CreateImage | Post /api/v1/images | Создание образа |
| ImagesAPI | CreateImageDownloadUrl | Post /api/v1/images/{image_id}/download-url | Создание ссылки на скачивание образа |
| ImagesAPI | DeleteImage | Delete /api/v1/images/{image_id} | Удаление образа |
| ImagesAPI | DeleteImageDownloadURL | Delete /api/v1/images/{image_id}/download-url/{image_url_id} | Удаление ссылки на образ |
| ImagesAPI | GetImage | Get /api/v1/images/{image_id} | Получение информации о образе |
| ImagesAPI | GetImageDownloadURL | Get /api/v1/images/{image_id}/download-url/{image_url_id} | Получение информации о ссылке на скачивание образа |
| ImagesAPI | GetImageDownloadURLs | Get /api/v1/images/{image_id}/download-url | Получение информации о ссылках на скачивание образов |
| ImagesAPI | GetImages | Get /api/v1/images | Получение списка образов |
| ImagesAPI | UpdateImage | Patch /api/v1/images/{image_id} | Обновление информации о образе |
| ImagesAPI | UploadImage | Post /api/v1/images/{image_id} | Загрузка образа |
| KnowledgeBasesAPI | AddAdditionalTokenPackageToKnowledgebase | Post /api/v1/cloud-ai/knowledge-bases/{id}/add-additional-token-package | Добавление дополнительного пакета токенов |
| KnowledgeBasesAPI | CreateKnowledgebase | Post /api/v1/cloud-ai/knowledge-bases | Создание базы знаний |
| KnowledgeBasesAPI | DeleteDocument | Delete /api/v1/cloud-ai/knowledge-bases/{id}/documents/{document_id} | Удаление документа из базы знаний |
| KnowledgeBasesAPI | DeleteKnowledgebase | Delete /api/v1/cloud-ai/knowledge-bases/{id} | Удаление базы знаний |
| KnowledgeBasesAPI | DownloadDocument | Get /api/v1/cloud-ai/knowledge-bases/{id}/documents/{document_id}/download | Скачивание документа из базы знаний |
| KnowledgeBasesAPI | GetKnowledgebase | Get /api/v1/cloud-ai/knowledge-bases/{id} | Получение базы знаний |
| KnowledgeBasesAPI | GetKnowledgebaseDocumentsV2 | Get /api/v2/cloud-ai/knowledge-bases/{id}/documents | Получение списка документов базы знаний |
| KnowledgeBasesAPI | GetKnowledgebaseStatistics | Get /api/v1/cloud-ai/knowledge-bases/{id}/statistic | Получение статистики использования токенов базы знаний |
| KnowledgeBasesAPI | GetKnowledgebases | Get /api/v1/cloud-ai/knowledge-bases | Получение списка баз знаний |
| KnowledgeBasesAPI | GetKnowledgebasesV2 | Get /api/v2/cloud-ai/knowledge-bases | Получение списка баз знаний (v2) |
| KnowledgeBasesAPI | LinkKnowledgebaseToAgent | Post /api/v1/cloud-ai/knowledge-bases/{id}/link/{agent_id} | Привязка базы знаний к агенту |
| KnowledgeBasesAPI | ReindexDocument | Post /api/v1/cloud-ai/knowledge-bases/{id}/documents/{document_id}/reindex | Переиндексация документа |
| KnowledgeBasesAPI | UnlinkKnowledgebaseFromAgent | Delete /api/v1/cloud-ai/knowledge-bases/{id}/link/{agent_id} | Отвязка базы знаний от агента |
| KnowledgeBasesAPI | UpdateKnowledgebase | Patch /api/v1/cloud-ai/knowledge-bases/{id} | Обновление базы знаний |
| KnowledgeBasesAPI | UploadFilesToKnowledgebase | Post /api/v1/cloud-ai/knowledge-bases/{id}/upload | Загрузка файлов в базу знаний |
| KubernetesAPI | CreateCluster | Post /api/v1/k8s/clusters | Создание кластера |
| KubernetesAPI | CreateClusterNodeGroup | Post /api/v1/k8s/clusters/{cluster_id}/groups | Создание группы нод |
| KubernetesAPI | DeleteCluster | Delete /api/v1/k8s/clusters/{cluster_id} | Удаление кластера |
| KubernetesAPI | DeleteClusterNode | Delete /api/v1/k8s/clusters/{cluster_id}/nodes/{node_id} | Удаление ноды |
| KubernetesAPI | DeleteClusterNodeGroup | Delete /api/v1/k8s/clusters/{cluster_id}/groups/{group_id} | Удаление группы нод |
| KubernetesAPI | GetCluster | Get /api/v1/k8s/clusters/{cluster_id} | Получение информации о кластере |
| KubernetesAPI | GetClusterKubeconfig | Get /api/v1/k8s/clusters/{cluster_id}/kubeconfig | Получение файла kubeconfig |
| KubernetesAPI | GetClusterNodeGroup | Get /api/v1/k8s/clusters/{cluster_id}/groups/{group_id} | Получение информации о группе нод |
| KubernetesAPI | GetClusterNodeGroups | Get /api/v1/k8s/clusters/{cluster_id}/groups | Получение групп нод кластера |
| KubernetesAPI | GetClusterNodes | Get /api/v1/k8s/clusters/{cluster_id}/nodes | Получение списка нод |
| KubernetesAPI | GetClusterNodesFromGroup | Get /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}/nodes | Получение списка нод, принадлежащих группе |
| KubernetesAPI | GetClusterResources | Get /api/v1/k8s/clusters/{cluster_id}/resources | Получение ресурсов кластера |
| KubernetesAPI | GetClusters | Get /api/v1/k8s/clusters | Получение списка кластеров |
| KubernetesAPI | GetK8SNetworkDrivers | Get /api/v1/k8s/network-drivers | Получение списка сетевых драйверов k8s |
| KubernetesAPI | GetK8SVersions | Get /api/v1/k8s/k8s-versions | Получение списка версий k8s |
| KubernetesAPI | GetKubernetesPresets | Get /api/v1/presets/k8s | Получение списка тарифов |
| KubernetesAPI | IncreaseCountOfNodesInGroup | Post /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}/nodes | Увеличение количества нод в группе на указанное количество |
| KubernetesAPI | ReduceCountOfNodesInGroup | Delete /api/v1/k8s/clusters/{cluster_id}/groups/{group_id}/nodes | Уменьшение количества нод в группе на указанное количество |
| KubernetesAPI | UpdateCluster | Patch /api/v1/k8s/clusters/{cluster_id} | Обновление информации о кластере |
| KubernetesAPI | UpdateClusterVersion | Patch /api/v1/k8s/clusters/{cluster_id}/versions/update | Обновление версии кластера |
| LocationsAPI | GetLocations | Get /api/v2/locations | Получение списка локаций |
| MailAPI | CreateDomainMailbox | Post /api/v1/mail/domains/{domain} | Создание почтового ящика |
| MailAPI | CreateMultipleDomainMailboxes | Post /api/v1/mail/domains/{domain}/batch | Множественное создание почтовых ящиков |
| MailAPI | DeleteMailbox | Delete /api/v1/mail/domains/{domain}/mailboxes/{mailbox} | Удаление почтового ящика |
| MailAPI | GetDomainMailInfo | Get /api/v1/mail/domains/{domain}/info | Получение почтовой информации о домене |
| MailAPI | GetDomainMailboxes | Get /api/v1/mail/domains/{domain} | Получение списка почтовых ящиков домена |
| MailAPI | GetMailbox | Get /api/v1/mail/domains/{domain}/mailboxes/{mailbox} | Получение почтового ящика |
| MailAPI | GetMailboxes | Get /api/v1/mail | Получение списка почтовых ящиков аккаунта |
| MailAPI | UpdateDomainMailInfo | Patch /api/v1/mail/domains/{domain}/info | Изменение почтовой информации о домене |
| MailAPI | UpdateMailbox | Patch /api/v1/mail/domains/{domain}/mailboxes/{mailbox} | Изменение почтового ящика |
| MailAPI | UpdateMailboxV2 | Patch /api/v2/mail/domains/{domain}/mailboxes/{mailbox} | Изменение почтового ящика |
| NetworkDrivesAPI | CreateNetworkDrive | Post /api/v1/network-drives | Создание сетевого диска |
| NetworkDrivesAPI | DeleteNetworkDrive | Delete /api/v1/network-drives/{network_drive_id} | Удаление сетевого диска по идентификатору |
| NetworkDrivesAPI | GetNetworkDrive | Get /api/v1/network-drives/{network_drive_id} | Получение сетевого диска |
| NetworkDrivesAPI | GetNetworkDrives | Get /api/v1/network-drives | Получение списка cетевых дисков |
| NetworkDrivesAPI | GetNetworkDrivesAvailableResources | Get /api/v1/network-drives/available-resources | Получение списка сервисов доступных для подключения диска |
| NetworkDrivesAPI | GetNetworkDrivesPresets | Get /api/v1/presets/network-drives | Получение списка доступных тарифов для сетевого диска |
| NetworkDrivesAPI | MountNetworkDrive | Post /api/v1/network-drives/{network_drive_id}/mount | Подключить сетевой диск к сервису |
| NetworkDrivesAPI | UnmountNetworkDrive | Post /api/v1/network-drives/{network_drive_id}/unmount | Отключить сетевой диск от сервиса |
| NetworkDrivesAPI | UpdateNetworkDrive | Patch /api/v1/network-drives/{network_drive_id} | Изменение сетевого диска по ID |
| PaymentsAPI | GetFinances | Get /api/v1/account/finances | Получение платежной информации |
| PaymentsAPI | GetServicePrices | Get /api/v1/account/services/cost | Получение стоимости сервисов |
| ProjectsAPI | AddBalancerToProject | Post /api/v1/projects/{project_id}/resources/balancers | Добавление балансировщика в проект |
| ProjectsAPI | AddClusterToProject | Post /api/v1/projects/{project_id}/resources/clusters | Добавление кластера в проект |
| ProjectsAPI | AddDatabaseToProject | Post /api/v1/projects/{project_id}/resources/databases | Добавление базы данных в проект |
| ProjectsAPI | AddDedicatedServerToProject | Post /api/v1/projects/{project_id}/resources/dedicated | Добавление выделенного сервера в проект |
| ProjectsAPI | AddServerToProject | Post /api/v1/projects/{project_id}/resources/servers | Добавление сервера в проект |
| ProjectsAPI | AddStorageToProject | Post /api/v1/projects/{project_id}/resources/buckets | Добавление хранилища в проект |
| ProjectsAPI | CreateProject | Post /api/v1/projects | Создание проекта |
| ProjectsAPI | DeleteProject | Delete /api/v1/projects/{project_id} | Удаление проекта |
| ProjectsAPI | GetAccountBalancers | Get /api/v1/projects/resources/balancers | Получение списка всех балансировщиков на аккаунте |
| ProjectsAPI | GetAccountClusters | Get /api/v1/projects/resources/clusters | Получение списка всех кластеров на аккаунте |
| ProjectsAPI | GetAccountDatabases | Get /api/v1/projects/resources/databases | Получение списка всех баз данных на аккаунте |
| ProjectsAPI | GetAccountDedicatedServers | Get /api/v1/projects/resources/dedicated | Получение списка всех выделенных серверов на аккаунте |
| ProjectsAPI | GetAccountServers | Get /api/v1/projects/resources/servers | Получение списка всех серверов на аккаунте |
| ProjectsAPI | GetAccountStorages | Get /api/v1/projects/resources/buckets | Получение списка всех хранилищ на аккаунте |
| ProjectsAPI | GetAllProjectResources | Get /api/v1/projects/{project_id}/resources | Получение всех ресурсов проекта |
| ProjectsAPI | GetProject | Get /api/v1/projects/{project_id} | Получение проекта по ID |
| ProjectsAPI | GetProjectBalancers | Get /api/v1/projects/{project_id}/resources/balancers | Получение списка балансировщиков проекта |
| ProjectsAPI | GetProjectClusters | Get /api/v1/projects/{project_id}/resources/clusters | Получение списка кластеров проекта |
| ProjectsAPI | GetProjectDatabases | Get /api/v1/projects/{project_id}/resources/databases | Получение списка баз данных проекта |
| ProjectsAPI | GetProjectDedicatedServers | Get /api/v1/projects/{project_id}/resources/dedicated | Получение списка выделенных серверов проекта |
| ProjectsAPI | GetProjectServers | Get /api/v1/projects/{project_id}/resources/servers | Получение списка серверов проекта |
| ProjectsAPI | GetProjectStorages | Get /api/v1/projects/{project_id}/resources/buckets | Получение списка хранилищ проекта |
| ProjectsAPI | GetProjects | Get /api/v1/projects | Получение списка проектов |
| ProjectsAPI | TransferResourceToAnotherProject | Put /api/v1/projects/{project_id}/resources/transfer | Перенести ресурс в другой проект |
| ProjectsAPI | UpdateProject | Put /api/v1/projects/{project_id} | Изменение проекта |
| S3API | AddStorageSubdomainCertificate | Post /api/v1/storages/certificates/generate | Добавление сертификата для поддомена хранилища |
| S3API | AddStorageSubdomains | Post /api/v1/storages/buckets/{bucket_id}/subdomains | Добавление поддоменов для хранилища |
| S3API | CreateStorage | Post /api/v1/storages/buckets | Создание хранилища |
| S3API | DeleteStorage | Delete /api/v1/storages/buckets/{bucket_id} | Удаление хранилища на аккаунте |
| S3API | DeleteStorageSubdomains | Delete /api/v1/storages/buckets/{bucket_id}/subdomains | Удаление поддоменов хранилища |
| S3API | GetStorageSubdomains | Get /api/v1/storages/buckets/{bucket_id}/subdomains | Получение списка поддоменов хранилища |
| S3API | GetStorageTransferStatus | Get /api/v1/storages/buckets/{bucket_id}/transfer-status | Получение статуса переноса хранилища от стороннего S3 в Timeweb Cloud |
| S3API | GetStorageUsers | Get /api/v1/storages/users | Получение списка пользователей хранилищ аккаунта |
| S3API | GetStorages | Get /api/v1/storages/buckets | Получение списка хранилищ аккаунта |
| S3API | GetStoragesPresets | Get /api/v1/presets/storages | Получение списка тарифов для хранилищ |
| S3API | TransferStorage | Post /api/v1/storages/transfer | Перенос хранилища от стороннего провайдера S3 в Timeweb Cloud |
| S3API | UpdateStorage | Patch /api/v1/storages/buckets/{bucket_id} | Изменение хранилища на аккаунте |
| S3API | UpdateStorageUser | Patch /api/v1/storages/users/{user_id} | Изменение пароля пользователя-администратора хранилища |
| SSHAPI | AddKeyToServer | Post /api/v1/servers/{server_id}/ssh-keys | Добавление SSH-ключей на сервер |
| SSHAPI | CreateKey | Post /api/v1/ssh-keys | Создание SSH-ключа |
| SSHAPI | DeleteKey | Delete /api/v1/ssh-keys/{ssh_key_id} | Удаление SSH-ключа по ID |
| SSHAPI | DeleteKeyFromServer | Delete /api/v1/servers/{server_id}/ssh-keys/{ssh_key_id} | Удаление SSH-ключей с сервера |
| SSHAPI | GetKey | Get /api/v1/ssh-keys/{ssh_key_id} | Получение SSH-ключа по ID |
| SSHAPI | GetKeys | Get /api/v1/ssh-keys | Получение списка SSH-ключей |
| SSHAPI | UpdateKey | Patch /api/v1/ssh-keys/{ssh_key_id} | Изменение SSH-ключа по ID |
| ServersAPI | AddServerIP | Post /api/v1/servers/{server_id}/ips | Добавление IP-адреса сервера |
| ServersAPI | CloneServer | Post /api/v1/servers/{server_id}/clone | Клонирование сервера |
| ServersAPI | CreateServer | Post /api/v1/servers | Создание сервера |
| ServersAPI | CreateServerDisk | Post /api/v1/servers/{server_id}/disks | Создание диска сервера |
| ServersAPI | CreateServerDiskBackup | Post /api/v1/servers/{server_id}/disks/{disk_id}/backups | Создание бэкапа диска сервера |
| ServersAPI | DeleteServer | Delete /api/v1/servers/{server_id} | Удаление сервера |
| ServersAPI | DeleteServerDisk | Delete /api/v1/servers/{server_id}/disks/{disk_id} | Удаление диска сервера |
| ServersAPI | DeleteServerDiskBackup | Delete /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id} | Удаление бэкапа диска сервера |
| ServersAPI | DeleteServerIP | Delete /api/v1/servers/{server_id}/ips | Удаление IP-адреса сервера |
| ServersAPI | GetConfigurators | Get /api/v1/configurator/servers | Получение списка конфигураторов серверов |
| ServersAPI | GetOsList | Get /api/v1/os/servers | Получение списка операционных систем |
| ServersAPI | GetServer | Get /api/v1/servers/{server_id} | Получение сервера |
| ServersAPI | GetServerDisk | Get /api/v1/servers/{server_id}/disks/{disk_id} | Получение диска сервера |
| ServersAPI | GetServerDiskAutoBackupSettings | Get /api/v1/servers/{server_id}/disks/{disk_id}/auto-backups | Получить настройки автобэкапов диска сервера |
| ServersAPI | GetServerDiskBackup | Get /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id} | Получение бэкапа диска сервера |
| ServersAPI | GetServerDiskBackups | Get /api/v1/servers/{server_id}/disks/{disk_id}/backups | Получение списка бэкапов диска сервера |
| ServersAPI | GetServerDisks | Get /api/v1/servers/{server_id}/disks | Получение списка дисков сервера |
| ServersAPI | GetServerIPs | Get /api/v1/servers/{server_id}/ips | Получение списка IP-адресов сервера |
| ServersAPI | GetServerLogs | Get /api/v1/servers/{server_id}/logs | Получение списка логов сервера |
| ServersAPI | GetServerStatistics | Get /api/v1/servers/{server_id}/statistics | Получение статистики сервера |
| ServersAPI | GetServerStatisticsNew | Get /api/v1/servers/{server_id}/statistics/{time_from}/{period}/{keys} | Получение статистики сервера |
| ServersAPI | GetServers | Get /api/v1/servers | Получение списка серверов |
| ServersAPI | GetServersPresets | Get /api/v1/presets/servers | Получение списка тарифов серверов |
| ServersAPI | GetSoftware | Get /api/v1/software/servers | Получение списка ПО из маркетплейса |
| ServersAPI | HardShutdownServer | Post /api/v1/servers/{server_id}/hard-shutdown | Принудительное выключение сервера |
| ServersAPI | ImageUnmountAndServerReload | Post /api/v1/servers/{server_id}/image-unmount | Отмонтирование ISO образа и перезагрузка сервера |
| ServersAPI | PerformActionOnBackup | Post /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id}/action | Выполнение действия над бэкапом диска сервера |
| ServersAPI | PerformActionOnServer | Post /api/v1/servers/{server_id}/action | Выполнение действия над сервером |
| ServersAPI | RebootServer | Post /api/v1/servers/{server_id}/reboot | Перезагрузка сервера |
| ServersAPI | ResetServerPassword | Post /api/v1/servers/{server_id}/reset-password | Сброс пароля сервера |
| ServersAPI | ShutdownServer | Post /api/v1/servers/{server_id}/shutdown | Выключение сервера |
| ServersAPI | StartServer | Post /api/v1/servers/{server_id}/start | Запуск сервера |
| ServersAPI | UpdateServer | Patch /api/v1/servers/{server_id} | Изменение сервера |
| ServersAPI | UpdateServerDisk | Patch /api/v1/servers/{server_id}/disks/{disk_id} | Изменение параметров диска сервера |
| ServersAPI | UpdateServerDiskAutoBackupSettings | Patch /api/v1/servers/{server_id}/disks/{disk_id}/auto-backups | Изменение настроек автобэкапов диска сервера |
| ServersAPI | UpdateServerDiskBackup | Patch /api/v1/servers/{server_id}/disks/{disk_id}/backups/{backup_id} | Изменение бэкапа диска сервера |
| ServersAPI | UpdateServerIP | Patch /api/v1/servers/{server_id}/ips | Изменение IP-адреса сервера |
| ServersAPI | UpdateServerNAT | Patch /api/v1/servers/{server_id}/local-networks/nat-mode | Изменение правил маршрутизации трафика сервера (NAT) |
| ServersAPI | UpdateServerOSBootMode | Post /api/v1/servers/{server_id}/boot-mode | Выбор типа загрузки операционной системы сервера |
| VPCAPI | CreateVPC | Post /api/v2/vpcs | Создание VPC |
| VPCAPI | DeleteVPC | Delete /api/v1/vpcs/{vpc_id} | Удаление VPC по ID сети |
| VPCAPI | GetVPC | Get /api/v2/vpcs/{vpc_id} | Получение VPC |
| VPCAPI | GetVPCPorts | Get /api/v1/vpcs/{vpc_id}/ports | Получение списка портов для VPC |
| VPCAPI | GetVPCServices | Get /api/v2/vpcs/{vpc_id}/services | Получение списка сервисов в VPC |
| VPCAPI | GetVPCs | Get /api/v2/vpcs | Получение списка VPCs |
| VPCAPI | UpdateVPCs | Patch /api/v2/vpcs/{vpc_id} | Изменение VPC по ID сети |
- AddBalancerToProject200Response
- AddBalancerToProjectRequest
- AddBitbucket
- AddClusterToProjectRequest
- AddCountries
- AddCountriesToAllowedList201Response
- AddCountriesToAllowedListRequest
- AddDatabaseToProjectRequest
- AddDedicatedServerToProjectRequest
- AddGit
- AddGithub
- AddGitlab
- AddIPsToAllowedList201Response
- AddIPsToAllowedListRequest
- AddIPsToBalancerRequest
- AddIps
- AddKeyToServerRequest
- AddProvider201Response
- AddServerIP201Response
- AddServerIPRequest
- AddServerToProjectRequest
- AddStorageSubdomainCertificateRequest
- AddStorageSubdomains200Response
- AddStorageSubdomainsRequest
- AddStorageToProjectRequest
- AddSubdomain201Response
- AddTokenPackage
- AddedSubdomain
- Agent
- AgentModelSettings
- AgentSettings
- AgentSettingsWidget
- ApiKey
- App
- AppConfiguration
- AppDiskStatus
- AppDomainsInner
- AppProvider
- AppsPresets
- AppsPresetsBackendPresetsInner
- AppsPresetsFrontendPresetsInner
- AutoBackup
- AutoReplyIsDisabled
- AutoReplyIsEnabled
- AutoreplyIsDisabled
- AutoreplyIsEnabled
- AvailabilityZone
- AvailableFrameworks
- AvailableFrameworksBackendFrameworksInner
- AvailableFrameworksFrontendFrameworksInner
- Backup
- Balancer
- BalancerNetworksInner
- BalancerNetworksInnerIpsInner
- BaseError
- BindFloatingIp
- Bonus
- Branch
- Bucket
- BucketDiskStats
- BucketUser
- BucketWebsiteConfig
- BucketWebsiteConfigErrorPagesInner
- CheckDomain200Response
- ClusterEdit
- ClusterEditOidcProvider
- ClusterIn
- ClusterInClusterNetworkCidr
- ClusterInConfiguration
- ClusterInMaintenanceSlot
- ClusterInOidcProvider
- ClusterOut
- ClusterResponse
- ClusterVersionEdit
- Clusterk8s
- ClustersResponse
- Commit
- ComponentsSchemasBaseError
- ConfigParameters
- ContainerRegistryPresetsInner
- ContainerRegistryRepositoriesInner
- CreateAdmin
- CreateAgent
- CreateAgent201Response
- CreateApiKey
- CreateApp
- CreateApp201Response
- CreateBalancer
- CreateBalancer200Response
- CreateBalancerCertificates
- CreateBalancerRule200Response
- CreateCluster
- CreateClusterAdmin
- CreateClusterInstance
- CreateDatabase201Response
- CreateDatabaseBackup201Response
- CreateDatabaseBackup409Response
- CreateDatabaseCluster201Response
- CreateDatabaseInstance201Response
- CreateDatabaseUser201Response
- CreateDb
- CreateDbAutoBackups
- CreateDedicatedServer
- CreateDedicatedServer201Response
- CreateDeploy201Response
- CreateDeployRequest
- CreateDns
- CreateDomainDNSRecord201Response
- CreateDomainMailbox201Response
- CreateDomainMailboxRequest
- CreateDomainRequest201Response
- CreateFloatingIp
- CreateFloatingIp201Response
- CreateInstance
- CreateKey201Response
- CreateKeyRequest
- CreateKnowledgebase
- CreateKnowledgebase201Response
- CreateMultipleDomainMailboxes201Response
- CreateMultipleDomainMailboxesRequest
- CreateMultipleDomainMailboxesRequestMailboxesInner
- CreateNetworkDrive
- CreateNetworkDrive201Response
- CreateProject
- CreateProject201Response
- CreateRule
- CreateServer
- CreateServer201Response
- CreateServerConfiguration
- CreateServerDisk201Response
- CreateServerDiskBackup201Response
- CreateServerDiskBackupRequest
- CreateServerDiskRequest
- CreateServerNetwork
- CreateStorage201Response
- CreateStorageRequest
- CreateStorageRequestConfigurator
- CreateToken201Response
- CreateVPC201Response
- CreateVpc
- CreatedApiKey
- DatabaseAdmin
- DatabaseAdminInstancesInner
- DatabaseCluster
- DatabaseClusterDisk
- DatabaseClusterNetworksInner
- DatabaseClusterNetworksInnerIpsInner
- DatabaseInstance
- DatabaseType
- DatabaseTypeRequirements
- Db
- DbDiskStats
- DbReplication
- DbType
- DedicatedServer
- DedicatedServerAdditionalService
- DedicatedServerPreset
- DedicatedServerPresetCpu
- DedicatedServerPresetDisk
- DedicatedServerPresetMemory
- DeleteBalancer200Response
- DeleteCluster200Response
- DeleteCountriesFromAllowedList200Response
- DeleteCountriesFromAllowedListRequest
- DeleteDatabase200Response
- DeleteDatabaseCluster200Response
- DeleteIPsFromAllowedList200Response
- DeleteIPsFromAllowedListRequest
- DeleteServer200Response
- DeleteServerIPRequest
- DeleteServiceResponse
- DeleteStorage200Response
- Deploy
- DeploySettingsInner
- DeployStatus
- DnsRecord
- DnsRecordData
- Document
- DocumentStatusInfo
- DocumentStatusInfoDetails
- Domain
- DomainAllowedBuyPeriodsInner
- DomainInfo
- DomainNameServer
- DomainNameServerItemsInner
- DomainPaymentPeriod
- DomainPrimeType
- DomainProlong
- DomainRegister
- DomainRequest
- DomainTransfer
- EditApiKey
- Finances
- FirewallGroup
- FirewallGroupInAPI
- FirewallGroupOutResponse
- FirewallGroupResource
- FirewallGroupResourceOutResponse
- FirewallGroupResourcesOutResponse
- FirewallGroupsOutResponse
- FirewallRule
- FirewallRuleDirection
- FirewallRuleInAPI
- FirewallRuleOutResponse
- FirewallRuleProtocol
- FirewallRulesOutResponse
- FloatingIp
- ForwardIsDisabled
- ForwardIsEnabled
- ForwardingIncomingIsDisabled
- ForwardingIncomingIsEnabled
- ForwardingOutgoingIsDisabled
- ForwardingOutgoingIsEnabled
- Frameworks
- Free
- GetAccountStatus200Response
- GetAccountStatus403Response
- GetAgentStatistics200Response
- GetAgentStatistics200ResponseMeta
- GetAgents200Response
- GetAgents200ResponseMeta
- GetAllProjectResources200Response
- GetAppDeploys200Response
- GetAppLogs200Response
- GetApps200Response
- GetAuthAccessSettings200Response
- GetAuthAccessSettings200ResponseWhiteList
- GetBalancerIPs200Response
- GetBalancerRules200Response
- GetBalancers200Response
- GetBalancersPresets200Response
- GetBranches200Response
- GetCommits200Response
- GetConfigurators200Response
- GetCountries200Response
- GetDatabaseAutoBackupsSettings200Response
- GetDatabaseBackups200Response
- GetDatabaseClusterTypes200Response
- GetDatabaseClusters200Response
- GetDatabaseInstances200Response
- GetDatabaseUsers200Response
- GetDatabases200Response
- GetDatabasesPresets200Response
- GetDedicatedServerPresetAdditionalServices200Response
- GetDedicatedServers200Response
- GetDedicatedServersPresets200Response
- GetDeployLogs200Response
- GetDeploySettings200Response
- GetDomain200Response
- GetDomainDNSRecords200Response
- GetDomainMailInfo200Response
- GetDomainNameServers200Response
- GetDomainRequests200Response
- GetDomains200Response
- GetFinances200Response
- GetFinances400Response
- GetFinances401Response
- GetFinances429Response
- GetFinances500Response
- GetFloatingIps200Response
- GetImage404Response
- GetKey200Response
- GetKeys200Response
- GetKnowledgebaseDocumentsV2200Response
- GetKnowledgebaseDocumentsV2200ResponseMeta
- GetKnowledgebaseStatistics200Response
- GetKnowledgebases200Response
- GetKnowledgebasesV2200Response
- GetKnowledgebasesV2200ResponseMeta
- GetLocations200Response
- GetMailboxes200Response
- GetNetworkDrives200Response
- GetNetworkDrivesAvailableResources200Response
- GetNetworkDrivesPresets200Response
- GetNotificationSettings200Response
- GetOsList200Response
- GetProjectBalancers200Response
- GetProjectClusters200Response
- GetProjectDatabases200Response
- GetProjectDedicatedServers200Response
- GetProjectServers200Response
- GetProjectStorages200Response
- GetProjects200Response
- GetProviders200Response
- GetRepositories200Response
- GetServerDiskAutoBackupSettings200Response
- GetServerDiskBackup200Response
- GetServerDiskBackups200Response
- GetServerDisks200Response
- GetServerIPs200Response
- GetServerLogs200Response
- GetServerStatistics200Response
- GetServerStatistics200ResponseCpuInner
- GetServerStatistics200ResponseDiskInner
- GetServerStatistics200ResponseNetworkTrafficInner
- GetServerStatistics200ResponseRamInner
- GetServerStatisticsNew200Response
- GetServers200Response
- GetServersPresets200Response
- GetServicePrices200Response
- GetServicePrices200ResponseMeta
- GetSoftware200Response
- GetStorageSubdomains200Response
- GetStorageTransferStatus200Response
- GetStorageUsers200Response
- GetStoragesPresets200Response
- GetTLD200Response
- GetTLDs200Response
- GetTokens200Response
- GetVPCPorts200Response
- GetVPCServices200Response
- GetVPCs200Response
- Image
- ImageDownload
- ImageDownloadResponse
- ImageDownloadsResponse
- ImageInAPI
- ImageOutResponse
- ImageStatus
- ImageUpdateAPI
- ImageUrlAuth
- ImageUrlIn
- ImagesOutResponse
- IncreaseNodes
- InfoServicePrice
- Invoice
- K8SVersionsResponse
- Knowledgebase
- KnowledgebaseV2
- Location
- LocationDto
- Mailbox
- MailboxAutoReply
- MailboxForwardingIncoming
- MailboxForwardingOutgoing
- MailboxResponse
- MailboxSpamFilter
- MasterPresetOutApi
- Meta
- Meta1
- MountNetworkDrive
- Network
- NetworkDrive
- NetworkDriveAvailableResource
- NetworkDrivePreset
- NetworkDrivePresetRead
- NetworkDrivePresetWrite
- NetworkDriveServiceListInner
- NetworkDriversResponse
- NodeGroupIn
- NodeGroupInConfiguration
- NodeGroupOut
- NodeGroupResponse
- NodeGroupsResponse
- NodeOut
- NodesResponse
- NotificationSetting
- NotificationSettingChannel
- NotificationSettingChannels
- NotificationSettingType
- OS
- OutgoingIsDisabled
- OutgoingIsEnabled
- PerformActionOnBackupRequest
- PerformActionOnServerRequest
- Policy
- PresetsBalancer
- PresetsDbs
- PresetsResponse
- PresetsStorage
- Project
- ProjectResource
- Provider
- Providers
- ReduceNodes
- RefreshApiKey
- RegistriesResponse
- RegistryEdit
- RegistryIn
- RegistryInConfiguration
- RegistryOut
- RegistryOutDiskStats
- RegistryResponse
- RemoveCountries
- RemoveIps
- RepositoriesResponse
- Repository
- Resource
- ResourceTransfer
- ResourceType
- Resources
- ResourcesResponse
- Rule
- S3Subdomain
- SchemasBaseError
- SchemasMeta
- SchemasPresetsResponse
- ServerBackup
- ServerDisk
- ServerIp
- ServerLog
- ServersConfigurator
- ServersConfiguratorRequirements
- ServersOs
- ServersOsRequirements
- ServersPreset
- ServersSoftware
- ServersSoftwareRequirements
- ServersStatistics
- ServersStatisticsListInner
- ServersStatisticsMeta
- ServiceCostType
- ServicePrice
- ServicePriceConfiguration
- ServicePriceType
- ServiceServicePrice
- ServiceServicePriceNodeGroupsInner
- SetLabels
- SettingCondition
- SpamFilterIsDisabled
- SpamFilterIsEnabled
- SpamProtectionIsDisabled
- SpamProtectionIsEnabled
- SshKey
- SshKeyUsedByInner
- Status
- StatusCompanyInfo
- Subdomain
- Tags
- TokenStatistic
- TopLevelDomain
- TopLevelDomainAllowedBuyPeriodsInner
- TransferStatus
- TransferStatusErrorsInner
- TransferStorageRequest
- URLType
- UpdateAdmin
- UpdateAgent
- UpdateAgentSettings
- UpdateAppSettings200Response
- UpdateAuthRestrictionsByCountriesRequest
- UpdateBalancer
- UpdateCluster
- UpdateDb
- UpdateDedicatedServerRequest
- UpdateDomain
- UpdateDomainAutoProlongation200Response
- UpdateDomainMailInfoRequest
- UpdateDomainNameServers
- UpdateDomainNameServersNameServersInner
- UpdateFloatingIp
- UpdateInstance
- UpdateKeyRequest
- UpdateKnowledgebase
- UpdateMailbox
- UpdateMailboxV2
- UpdateMailboxV2200Response
- UpdateNetworkDrive
- UpdateNotificationSettingsRequest
- UpdateNotificationSettingsRequestSettingsInner
- UpdateNotificationSettingsRequestSettingsInnerChannels
- UpdateProject
- UpdateRule
- UpdateServer
- UpdateServerConfigurator
- UpdateServerDiskBackupRequest
- UpdateServerDiskRequest
- UpdateServerIPRequest
- UpdateServerNATRequest
- UpdateServerOSBootModeRequest
- UpdateSettings
- UpdateStorageRequest
- UpdateStorageRequestConfigurator
- UpdateStorageUser200Response
- UpdateStorageUserRequest
- UpdateToken200Response
- UpdateVpc
- UploadFilesToKnowledgebase200Response
- UploadSuccessful
- UploadSuccessfulResponse
- UrlStatus
- Use
- Vds
- VdsDisksInner
- VdsImage
- VdsNetworksInner
- VdsNetworksInnerIpsInner
- VdsOs
- VdsSoftware
- Vpc
- VpcPort
- VpcPortService
- VpcService
- WorkerPresetOutApi
Authentication schemes defined for the API:
- Type: HTTP Bearer token authentication
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime