Cluster · разработчикам
Маршруты Cluster
Параметры и значения по умолчанию соответствуют сигнатурам ядра. Типы основных полей и формат HTTP описаны в API.md, методы клиентского App в SDK.md. На сайте token, csrf и source добавляет HTTP-служба, передавать их в теле нельзя. В модульном API контекст ctx добавляет ядро. Формат JSON и проверки прав описаны в API.md и SDK.md.
HTTP
| Маршрут | Параметры |
|---|---|
POST admin/access | id, reason, password, code=None, minutes=30 |
POST admin/access/close | id, grant |
POST admin/access/history | id |
POST admin/access/request | id, grant, action, data=None |
POST admin/catalog | search='', state='all' |
POST admin/codes | period, count=10 |
POST admin/diff | module, before, after, path=None, cursor=None |
POST admin/files | module, version, path=None, cursor=None |
POST admin/image | module, kind, offset=0 |
POST admin/moderate | module, action, version=None |
POST admin/panel | `` |
POST admin/profile | id |
POST admin/recover | id, reason |
POST admin/user | id, action |
POST admin/users | `` |
POST admin/verification/requests | state='pending', after=None |
POST admin/verification/review | request, decision, reason='' |
POST admin/verification/set | id, verified, reason='' |
POST admin/versions | module |
POST auth/bind | data, password, code |
POST auth/delete | password, code |
POST auth/email | address, password, code |
POST auth/login | login, password, code=None |
POST auth/logout | `` |
POST auth/mini | data, code=None |
POST auth/owner | id, telegram=None, password=None, code=None, remove=False, target=None |
POST auth/password | password, new_password, code=None |
GET auth/profile | `` |
POST auth/redeem | mail_code, purpose, password=None |
POST auth/register | login, address, password, terms=False, age_group=None, guardian=False |
POST auth/resend | address |
POST auth/reset | address |
POST auth/restore | password, code |
POST auth/totp/finish | code |
POST auth/totp/start | password, code=None |
POST backup/restore | id, file, password, code |
POST billing/cancel | `` |
POST billing/checkout | period, request |
POST billing/info | `` |
POST billing/refresh | `` |
POST billing/renew | enabled |
POST bot/attach | bot_token, password=None, code=None, unit=None |
POST bot/detach | password=None, code=None, unit=None |
POST bot/managed | username, title, password=None, code=None, unit=None |
GET bot/status | unit=None |
POST catalog/archive | module, version, archived=True |
POST catalog/artwork | module, kind, file=None |
POST catalog/check | module, version |
POST catalog/complaint | module, message |
POST catalog/detail | module |
POST catalog/diff | module, before, after, path=None, cursor=None |
POST catalog/files | module, version, path=None, cursor=None |
POST catalog/image | module, kind, offset=0 |
POST catalog/import | url, ref=None |
POST catalog/install | id, module, version, slot, granted, aliases=None |
POST catalog/list | search='', own=False |
POST catalog/manage | module |
POST catalog/publish | file, manifest, module=None, public=None |
POST catalog/remove | module, confirmation |
POST catalog/review | module, rating, message |
POST catalog/tester | module, visible=False |
POST catalog/testers | module, target, remove=False |
POST catalog/update | module, title, description, public |
POST catalog/versions | module |
POST exchange/approve | id, accept=True |
POST interface/action | id, instance, action, values, request, confirmation=None |
POST interface/aliases | id, instance, aliases, access=None, prefix=None |
POST interface/configure | id, instance, values, revision |
POST interface/dependency | id, instance, module, slot |
POST interface/files | id, instance, after=None, limit=50 |
POST interface/result | request |
POST interface/view | id, instance, lang='ru' |
POST people/artwork | kind, file=None |
POST people/friend | id, action |
POST people/friends | `` |
POST people/get | id |
POST people/image | id, kind, offset=0 |
POST people/search | query, after=None |
POST people/update | display_name='', about='', visibility=None, requests=True |
POST people/verification/cancel | request |
POST people/verification/request | category, message, links=None |
GET portal/dashboard | `` |
POST portal/metrics | id |
POST portal/request | id, action, data=None |
POST subscription/checkout | period, request |
POST subscription/redeem | code |
GET subscription/status | `` |
POST support/finish | id |
POST support/grant | id, password, code, enabled=True |
POST support/request | id, action, data |
POST telegram/begin | phone, api_id, api_hash, password=None, code=None, proxy=None, unit=None |
POST telegram/cancel | unit=None |
POST telegram/finish | id, code=None, password=None, replace_bot=False, unit=None |
POST telegram/qr | api_id, api_hash, password=None, code=None, proxy=None, unit=None |
POST telegram/qr/status | id, unit=None |
GET telegram/status | unit=None |
POST terminal/get | id, after=None |
POST terminal/input | id, data |
POST terminal/list | id |
POST terminal/resize | id, cols, rows |
POST terminal/start | id, command='', interactive=False, private=False |
POST terminal/stop | id |
POST updates/apply | id, instance, version, granted, backup=True |
POST updates/policy | id, instance, mode |
POST updates/preview | id, instance, version |
POST updates/remove | id, instance, data=False |
Модуль
| Маршрут | Параметры |
|---|---|
bot/invoke | method, data=None |
bot/request | method, chat=None, data=None |
bot/send_file | chat, file, kind='document', caption='', reply_markup=None, options=None |
buttons/answer | text='', alert=False |
buttons/delete | form |
buttons/edit | text, options=None |
buttons/form | chat, text, buttons, ttl=3600, users=None, media=None, receiver=None, replace=False, method='sendMessage', options=None |
buttons/update | form, text=None, method=None, options=None |
config/get | `` |
core/aliases | instance, values, revision |
core/commands | instance |
core/configuration | instance |
core/configure | instance, values, revision |
core/info | `` |
core/modules | offset=0 |
core/preferences | values, revision |
core/settings | `` |
db/delete | key, module=None, slot=None |
db/get | key, default=None, module=None, slot=None |
db/keys | module=None, slot=None, after=None, limit=100 |
db/set | key, value, ttl=None, module=None, slot=None |
events/poll | kind, wait=0 |
exchange/clear | id, before |
exchange/events | id, after=0, limit=100 |
exchange/get | id |
exchange/history | id |
exchange/list | after=None, limit=100 |
exchange/request | peer, module, slot, resource, fields=None, mode='permanent', direction='receive', group=None |
exchange/revoke | id |
exchange/transfer | id, value=None |
files/create | filename, size, sha256=None, ttl=None |
files/delete | id |
files/finish | id |
files/list | after=None, limit=100 |
files/read | id, offset=0, size=65536 |
files/write | id, offset, data |
interface/get | page |
interface/set | page, data |
logs/write | message, level='info' |
modules/call | module, function, values=None, slot=None |
modules/emit | module, signal, values=None, slot=None |
modules/result | request |
requests/create | handler |
requests/revoke | handler |
router/done | result=None, error=None |
router/poll | wait=0 |
router/register | interface |
tasks/cancel | id |
tasks/create | handler, values, at, interval=None, retry=0, request=None |
tasks/delete | id |
tasks/get | id |
tasks/list | `` |
telegram/invoke | method, chat=None, data=None |
telegram/request | method, chat=None, data=None |
web/close | id |
web/download | url, filename, maximum=10485760 |
web/fetch | url, method='GET', body=None, headers=None, binary=False |
web/open | url |
web/profile | proxy=None, cookies=True, domain=None |
web/receive | id, wait=10 |
web/request | url, method='GET', body=None |
web/send | id, data |
web/upload | url, file, method='POST', headers=None |
Оператор
| Маршрут | Параметры |
|---|---|
actor/check | id, actor, action, instance=None |
auth/recover | id, reason |
billing/webhook | payload, signature |
bot/service | token |
bot/update | secret, data, id='service' |
bot/webhook | url, secret, id='service' |
module/bind | id, instance |
module/grant | id, instance, granted |
module/install | id, module, slot, declared, granted, version='0.1.0', interface=None, aliases=None |
module/start | id, instance |
queue/claim | worker, seconds=30 |
queue/complete | id, worker, lease, result |
queue/put | id, action, data, request |
requests/incoming | id, module, slot, handler, secret, data, source='local', request=None |
subscription/codes | period, count=10 |
subscription/grant | id, period='month', request='test' |
unit/create | owner, request |
unit/get | id |
unit/owner | id, actor, target, remove=False, proof=None, telegram=None |
unit/settings | id, rules, instance=None |
unit/state | id, state, instance=None |
unit/trust | id, actor, target, actions, modules=None |
Модульный конфигуратор
Внутренние методы core/info, core/settings, core/preferences, core/modules, core/configuration, core/configure, core/commands, core/aliases доступны через SDK модуля. Обычный HTTP API их не публикует. Аргументы, результаты и проверки описаны в SDK.md.