Справочник: какие endpoint'ы есть в Ринго, какими методами они вызываются и кто на них ходит.
| Метод | Где применяется |
|---|---|
GET |
Чтение данных, скачивание файлов (профили, сертификаты, пакеты, установщики) |
POST |
Создание объектов, отправка команд на устройства, запуск операций (поиск, экспорт, синхронизация), загрузка файлов |
PATCH |
Изменение существующего объекта |
DELETE |
Удаление объекта |
PUT |
Только протокольные endpoint'ы устройств: /mdm/checkin, /mdm/connect, /agent/checkin, /agent/connect |
PUTв/api/v1/*не используется — обновление везде черезPATCH.
Массовое удаление выполняется черезPOST(/api/v1/apps-categories/delete,/api/v1/device-users/delete-batch), а не черезDELETE.
| Кто | Префикс |
|---|---|
| Управляемое устройство (Apple MDM) | /mdm/* |
| Управляемое устройство (SCEP) | /scep, /scep-proxy |
| Агент Ринго (Windows / Linux / macOS) | /agent/* |
| Приложение Self Service на устройстве | /api/v1/self-service/* |
| Браузер устройства при регистрации | /enroll/* |
| Веб-интерфейс администратора | /api/v1/* |
На
/mdm,/scep,/agent,/enrollи/api/v1/self-serviceходят сами устройства, поэтому эти пути должны быть доступны снаружи. Остальное/api/v1/*вызывает только веб-интерфейс — доступ к нему можно ограничивать.
/mdm/*| Endpoint | Методы |
|---|---|
/mdm/checkin |
PUT |
/mdm/connect |
PUT |
/mdm/enroll |
GET |
/mdm/enroll/profile |
POST |
GET /mdm/enroll и POST /mdm/enroll/profile — устройство получает профиль регистрацииPUT /mdm/checkin — регистрация устройства, обновление токенаPUT /mdm/connect — устройство забирает команду из очереди и возвращает результатОбмен идёт в формате plist (XML), не JSON.
/scep, /scep-proxy| Endpoint | Методы |
|---|---|
/scep |
GET POST |
/scep-proxy |
GET POST |
GET — GetCACert и GetCACapsPOST — PKIOperation, выпуск сертификата устройствуТип операции передаётся в query-параметре operation. /scep-proxy используется при выпуске сертификатов внешним УЦ.
/agent/*| Endpoint | Методы |
|---|---|
/agent/bundle |
GET |
/agent/certificate |
POST |
/agent/checkin |
PUT |
/agent/connect |
PUT |
/agent/enroll |
GET |
/agent/manifest |
GET |
GET /agent/enroll, /agent/bundle, /agent/manifest — скачивание установщика, пакета и манифеста (параметры os_type, arch)POST /agent/certificate — получение сертификата агентаPUT /agent/checkin — регистрация агентаPUT /agent/connect — получение команды и возврат результатаУправление агентом со стороны администратора — это отдельные endpoint'ы
/api/v1/agent/*, на них ходит веб-интерфейс.
/api/v1/self-service/*| Endpoint | Методы |
|---|---|
/api/v1/self-service/auth |
POST |
/api/v1/self-service/categories |
GET |
/api/v1/self-service/categories/{id}/entities |
GET |
/api/v1/self-service/entities |
GET |
/api/v1/self-service/policies/{id}/execute |
POST |
/api/v1/self-service/policies/{id}/execution |
GET |
/api/v1/self-service/profiles/{id}/install |
POST |
/api/v1/self-service/profiles/{id}/instance |
GET |
/api/v1/self-service/profiles/{id}/remove |
POST |
/api/v1/self-service/refresh |
POST |
POST /api/v1/self-service/auth — вход по UDID устройства и зашифрованному токенуPOST /api/v1/self-service/refresh — обновление токена/enroll/*| Endpoint | Методы |
|---|---|
/enroll |
GET |
/enroll/auth |
POST |
/enroll/{filename} |
GET |
GET /enroll и GET /enroll/{filename} — страница регистрации и её статикаPOST /enroll/auth — вход пользователя устройства/api/v1/*Все endpoint'ы ниже вызывает административная веб-консоль. Токен передаётся в заголовке X-Auth-Token, доступ определяется правами роли: Администрирование → Роли пользователей.
| Endpoint | Методы |
|---|---|
/api/v1/auth |
POST |
/api/v1/auth/2fa |
POST |
/api/v1/auth/logout |
GET |
/api/v1/auth/refresh |
GET |
/api/v1/auth/session-expired |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/user |
GET POST PATCH |
/api/v1/user/2fa |
POST DELETE |
/api/v1/user/2fa/prepare |
POST |
/api/v1/user/list |
GET |
/api/v1/user/{id} |
GET PATCH DELETE |
/api/v1/user/{id}/groups |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/roles |
GET POST |
/api/v1/roles/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/groups/device-users/smart |
GET POST |
/api/v1/groups/device-users/smart/{id} |
GET PATCH DELETE |
/api/v1/groups/device-users/smart/{id}/users |
GET |
/api/v1/groups/device-users/static |
GET POST |
/api/v1/groups/device-users/static/{id} |
GET PATCH DELETE |
/api/v1/groups/device-users/static/{id}/users |
GET |
/api/v1/groups/device/{deviceId} |
GET |
/api/v1/groups/devices/export |
POST |
/api/v1/groups/devices/smart |
GET POST |
/api/v1/groups/devices/smart/{id} |
GET PATCH DELETE |
/api/v1/groups/devices/smart/{id}/devices |
GET |
/api/v1/groups/devices/static |
GET POST |
/api/v1/groups/devices/static/{id} |
GET PATCH DELETE |
/api/v1/groups/devices/static/{id}/devices |
GET |
/api/v1/groups/users |
GET POST |
/api/v1/groups/users/{id} |
GET PATCH DELETE |
/api/v1/groups/users/{id}/users |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/devices |
GET |
/api/v1/devices/count |
GET |
/api/v1/devices/criteria |
POST |
/api/v1/devices/criterion-values |
GET |
/api/v1/devices/export-csv |
POST |
/api/v1/devices/search |
POST |
/api/v1/devices/sync/config-profiles |
POST |
/api/v1/devices/sync/remove-config-profile |
POST |
/api/v1/devices/{id} |
GET DELETE |
/api/v1/devices/{id}/activation-info |
POST |
/api/v1/devices/{id}/applications |
GET |
/api/v1/devices/{id}/ard/disable |
POST |
/api/v1/devices/{id}/ard/enable |
POST |
/api/v1/devices/{id}/available-os-updates |
POST |
/api/v1/devices/{id}/bluetooth/disable |
POST |
/api/v1/devices/{id}/bluetooth/enable |
POST |
/api/v1/devices/{id}/clear-passcode |
POST |
/api/v1/devices/{id}/clear-restrictions-password |
POST |
/api/v1/devices/{id}/extension-attributes |
GET |
/api/v1/devices/{id}/lock |
POST |
/api/v1/devices/{id}/lock-mobile |
POST |
/api/v1/devices/{id}/lost-mode/disable |
POST |
/api/v1/devices/{id}/lost-mode/enable |
POST |
/api/v1/devices/{id}/os-update |
POST |
/api/v1/devices/{id}/renew-enroll-profile |
POST |
/api/v1/devices/{id}/restart |
POST |
/api/v1/devices/{id}/security/info |
POST |
/api/v1/devices/{id}/send-blank-push |
POST |
/api/v1/devices/{id}/set-firmware-password |
POST |
/api/v1/devices/{id}/set-recovery-lock |
POST |
/api/v1/devices/{id}/shutdown |
POST |
/api/v1/devices/{id}/unroll |
POST |
/api/v1/devices/{id}/update-extension-attribute-value |
POST |
/api/v1/devices/{id}/update-inventory |
POST |
/api/v1/devices/{id}/user |
GET |
/api/v1/devices/{id}/user/link |
POST |
/api/v1/devices/{id}/user/unlink |
POST |
/api/v1/devices/{id}/wallpaper |
POST |
/api/v1/devices/{id}/wipe |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/device-users |
GET POST |
/api/v1/device-users/criteria/options |
GET |
/api/v1/device-users/criteria/values |
GET |
/api/v1/device-users/delete-batch |
POST |
/api/v1/device-users/sync/ldap |
POST |
/api/v1/device-users/upload |
POST |
/api/v1/device-users/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/extension-attributes |
GET POST |
/api/v1/extension-attributes/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/config-profiles |
GET POST |
/api/v1/config-profiles/device/{deviceId} |
GET |
/api/v1/config-profiles/{id} |
GET PATCH DELETE |
/api/v1/config-profiles/{id}/download |
GET |
/api/v1/config-profiles/{id}/logs |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/policies |
GET POST |
/api/v1/policies/device/{deviceId} |
GET |
/api/v1/policies/runs |
GET |
/api/v1/policies/runs/{id} |
GET |
/api/v1/policies/runs/{id}/acknowledge |
POST |
/api/v1/policies/runs/{id}/cancel |
POST |
/api/v1/policies/runs/{id}/rerun |
POST |
/api/v1/policies/{id} |
GET PATCH DELETE |
/api/v1/policies/{id}/acknowledge |
POST |
/api/v1/policies/{id}/rerun |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/scripts |
GET POST |
/api/v1/scripts/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/packages |
GET POST |
/api/v1/packages/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/package-points |
GET POST |
/api/v1/package-points/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/device-applications |
GET POST |
/api/v1/device-applications/search |
GET |
/api/v1/device-applications/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/apps-categories |
GET POST PATCH |
/api/v1/apps-categories/delete |
POST |
/api/v1/apps-categories/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/categories |
GET POST |
/api/v1/categories/{id} |
GET PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/mass-actions |
GET POST |
/api/v1/mass-actions/runs |
GET |
/api/v1/mass-actions/{id} |
GET DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/mdm/certificate |
POST |
/api/v1/mdm/certificate-metadata |
GET PATCH |
/api/v1/mdm/commands |
GET |
/api/v1/mdm/commands/{uuid} |
GET |
/api/v1/mdm/commands/{uuid}/cancel |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/agent/command/{id} |
GET |
/api/v1/agent/remove-ringo-commands |
GET |
/api/v1/agent/{udid}/command |
POST |
/api/v1/agent/{udid}/status |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/pki/certificates |
GET |
/api/v1/pki/certificates/ca/built-in |
GET |
/api/v1/pki/certificates/ca/trusted |
GET POST |
/api/v1/pki/certificates/ca/trusted/{id} |
GET DELETE |
/api/v1/pki/certificates/{id} |
GET |
/api/v1/pki/certificates/{id}/backup |
POST |
/api/v1/pki/certificates/{id}/csr |
POST |
/api/v1/pki/certificates/{id}/download |
POST |
/api/v1/pki/certificates/{id}/profile |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/ldap |
GET POST DELETE |
/api/v1/ldap/groups/membership |
POST |
/api/v1/ldap/groups/search |
POST |
/api/v1/ldap/groups/search-options |
POST |
/api/v1/ldap/test |
POST |
/api/v1/ldap/users/search |
POST |
/api/v1/ldap/users/search-options |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/audit |
GET |
/api/v1/audit/export-csv/log |
POST |
/api/v1/audit/export-csv/logs |
POST |
/api/v1/audit/filters |
GET |
/api/v1/audit/{id} |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/history |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/settings |
GET PATCH |
| Endpoint | Методы |
|---|---|
/api/v1/features |
GET |
/api/v1/features/{key} |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/licenses |
GET |
/api/v1/licenses/all |
GET |
/api/v1/licenses/all/inactive |
GET |
/api/v1/licenses/upload |
POST |
| Endpoint | Методы |
|---|---|
/api/v1/database-cleanup |
GET POST |
/api/v1/database-cleanup/base |
GET PATCH |
/api/v1/database-cleanup/cleanup |
POST |
/api/v1/database-cleanup/runs |
GET |
/api/v1/database-cleanup/runs/{id} |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/cron-jobs |
GET |
/api/v1/cron-jobs/{id} |
PATCH DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/scope |
GET |
/api/v1/scope/target/{id} |
GET |
/api/v1/scope/{id} |
DELETE |
| Endpoint | Методы |
|---|---|
/api/v1/version |
GET |
| Endpoint | Методы |
|---|---|
/api/v1/product-info |
GET |