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

API v2.4

Быстрый старт

REST API Alpha Space позволяет управлять узлами, политиками и журналами доступа из кода. Базовый адрес — api.alphaspace.io, формат ответа — JSON.

1. Создайте API-ключ

В консоли откройте «Настройки → Ключи доступа» и создайте ключ с ролью nodes:write.

2. Проверьте соединение

Запросите список узлов — это самый быстрый способ убедиться, что ключ работает.

3. Создайте первый узел

Укажите регион и лимиты. Узел появится в контуре через 30–60 секунд.

Все примеры используют переменную окружения ALPHA_TOKEN. Не храните ключи в репозитории.

Аутентификация

Передавайте ключ в заголовке Authorization. Ключ привязан к проекту и роли: для чтения достаточно read, для изменений — write.

terminal — проверка ключа

curl -s https://api.alphaspace.io/v1/nodes \
  -H "Authorization: Bearer $ALPHA_TOKEN" \
  -H "Accept: application/json"

Эндпоинты

Базовый адрес: https://api.alphaspace.io. Все ответы в JSON, коды ошибок описаны ниже.

GET

/v1/nodes

Список узлов контура с состоянием и метриками.

POST

/v1/nodes

Создание узла в выбранном регионе.

GET

/v1/nodes/{id}/metrics

Метрики узла за период (CPU, память, сеть).

POST

/v1/policies

Создание политики доступа.

GET

/v1/audit-events

Журнал действий команды.

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

Создание объекта в регионе eu-central. Ответ содержит идентификатор и состояние обработки.

terminal — create

curl -s -X POST https://api.alphaspace.io/v1/nodes \
  -H "Authorization: Bearer $ALPHA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "first", "region": "eu-central"}'

Ошибки

Ошибки возвращаются с машиночитаемым полем code и человекочитаемым message.

401	Ключ отсутствует или истёк.
403	У ключа нет нужной роли.
409	Узел с таким именем уже существует.
429	Превышен лимит запросов: 600 в минуту.

SDK и интеграции

Официальные SDK и готовые коннекторы. Если нужного нет — используйте HTTP API, он полностью документирован.

TerraformKubernetesGitHub ActionsGrafanaOpenTelemetryPagerDutySlackVault

История версий

v2.4 — текущая версия API. Совместима с предыдущей, изменения только аддитивные.

Обновлены примеры и описания ошибок.
Добавлены поля состояния и времени обновления.
Alpha Space 2.4: приватная магистраль и новые регионы — подробности релиза.

Помощь

Не нашли ответ? Поддержка отвечает в рабочие часы, а дежурный инженер — круглосуточно при инцидентах.

Написать в поддержку