Frontend Public API

Управление платформой: авторизация, компании, биллинг

Интерактивная документация¶

Эндпоинты¶

GET /frontend/api/agent/audit¶

List Agent Audit

Параметры¶

• limit (query, integer):

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/agent/devices¶

List Agent Devices

Ответ¶

• 200: Successful Response

DELETE /frontend/api/agent/devices/{device_id}¶

Revoke Agent Device

Параметры¶

• device_id (path, string) (обязательно):

Ответ¶

• 204: Successful Response
• 422: Validation Error

PATCH /frontend/api/agent/devices/{device_id}/policy¶

Update Agent Device Policy

Параметры¶

• device_id (path, string) (обязательно):

Запрос¶

Content-Type: application/json

{
  "policy": <any> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/agent/discover¶

Agent Discover

Параметры¶

• origin (query): Opt-in override публичного origin (lvh.me dev)

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/agent/download/{platform}¶

Download Agent

Параметры¶

• platform (path, string) (обязательно):

Ответ¶

• 200: Successful Response
• 422: Validation Error

POST /frontend/api/agent/pairing¶

Create Agent Pairing Code

Ответ¶

• 200: Successful Response

POST /frontend/api/agent/register¶

Register Agent Device

Параметры¶

• origin (query): Opt-in override публичного origin (lvh.me dev)

Запрос¶

Content-Type: application/json

{
  "pairing_code": <string> (обязательно),  // 6-значный pairing code из браузера
  "device_id": <string> (обязательно),  // UUID устройства
  "device_name": <string> (обязательно),  // Имя устройства
  "os": <string> (обязательно),  // ОС
  "hostname": <string> (обязательно),  // hostname
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

POST /frontend/api/agent/register-with-auth¶

Register Agent Device With Auth

Параметры¶

• origin (query): Opt-in override публичного origin (lvh.me dev)

Запрос¶

Content-Type: application/json

{
  "device_id": <string> (обязательно),  // UUID устройства
  "device_name": <string> (обязательно),  // Имя устройства
  "os": <string> (обязательно),  // ОС
  "hostname": <string> (обязательно),  // hostname
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/agent/releases/artifact/{platform}¶

Serve Local Release Artifact

Параметры¶

• platform (path, string) (обязательно):

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/agent/releases/status¶

Agent Releases Status

Ответ¶

• 200: Successful Response

POST /frontend/api/companies¶

Create Company

Создание новой компании

Аргументы: request_data: Данные компании request: FastAPI request container: DI контейнер

Возвращает: Информация о созданной компании и URL для редиректа

Запрос¶

Content-Type: application/json

{
  "name": <string> (обязательно),  // 
  "slug": <string> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

POST /frontend/api/companies/check-slug¶

Check Slug

Проверка доступности slug для субдомена

Аргументы: request: Запрос с slug container: DI контейнер

Возвращает: Информация о доступности slug

Запрос¶

Content-Type: application/json

{
  "slug": <string> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/companies/me¶

Get My Companies

Возвращает компании текущего пользователя с subdomain и ролями.

Ответ¶

• 200: Successful Response

DELETE /frontend/api/companies/{company_id}/system-access¶

Leave Company As System Member

Параметры¶

• company_id (path, string) (обязательно):

Ответ¶

• 200: Successful Response
• 422: Validation Error

POST /frontend/api/companies/{company_id}/system-access¶

Enter Company As System Member

Параметры¶

• company_id (path, string) (обязательно):

Запрос¶

Content-Type: application/json

{
  "role": <string> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error