Skip to content
API находится в стадии beta и может измениться без предварительного уведомления.

Эндпоинты проектов

Все эндпоинты проектов находятся под /projects.

CRUD проектов

МетодЭндпоинтОписание
POST/projects/Создать проект
GET/projects/Список проектов
GET/projects/:slugПолучить проект
PATCH/projects/:slugОбновить проект
DELETE/projects/:slugУдалить проект (только owner)

Создание

json
{
  "name": "Моё приложение",
  "description": "Описание",
  "is_public": true
}

INFO

slug всегда генерируется автоматически из имени проекта и не может быть указан в запросе.

Членство

МетодЭндпоинтОписание
POST/projects/:slug/joinВступить (публичные)
DELETE/projects/:slug/leaveПокинуть

Участники

МетодЭндпоинтОписание
GET/projects/:slug/membersСписок участников
POST/projects/:slug/membersДобавить участника
PATCH/projects/:slug/members/:idОбновить роль
DELETE/projects/:slug/members/:idУдалить участника
POST/projects/:slug/transfer-ownershipПередать владение

Добавление участника

json
{
  "email": "user@example.com",
  "role": "member",
  "permissions": ["can_deploy"]
}

Участники добавляются по email. Разрешения используют строковые ключи (например, "can_deploy"), а не UUID.

Передача владения

json
{
  "new_owner_id": "new-owner-uuid"
}

Разрешения

МетодЭндпоинтОписание
GET/projects/:slug/permissionsСписок разрешений
POST/projects/:slug/permissionsСоздать разрешение
PATCH/projects/:slug/permissions/:idОбновить
DELETE/projects/:slug/permissions/:idУдалить

Создание разрешения

json
{
  "key": "can_deploy",
  "display_name": "Can Deploy",
  "description": "Разрешить деплой",
  "is_default": false
}

OAuth-клиенты проекта

МетодЭндпоинтОписание
POST/projects/:slug/clientsСоздать клиент
GET/projects/:slug/clientsСписок клиентов

Приглашения проекта

МетодЭндпоинтОписание
GET/projects/:slug/invitesСписок приглашений
POST/projects/:slug/invitesСоздать приглашение
DELETE/projects/:slug/invites/:idОтменить приглашение

Создание приглашения

json
{
  "email": "user@example.com",
  "role": "member",
  "redirect_url": "https://myapp.com/welcome"
}

INFO

Приглашения истекают через 7 дней.

Подробнее: Проекты.

HitKey Service License.