REST API v1
Mọi endpoint nằm dưới /api/v1/, dùng cùng quy tắc kiểm tra dữ liệu và cùng khóa quyền với giao diện web. Không có bộ quyền API riêng.
https://<máy chủ Access Hub>/api/v1Bắt đầu nhanh
- 1Tạo token API. Trong Access Hub, vào Quản trị, Quản lý API (cần quyền
api-tokens.manage). Chọn người dùng mà token đại diện, bó hẹp quyền, đặt hạn dùng và dải IP nếu cần. - 2Gọi endpoint đầu tiên. Mọi request gửi
Authorization: BearervàAccept: application/json. Dữ liệu tự lọc theo công ty. - 3Đọc danh sách và lọc. Danh sách trả 15 dòng mỗi trang trong khóa
data, trang tiếp theo dùng?page=2. Mỗi tài nguyên có bộ lọc riêng, ví dụ máy chủ nhậnsearch,environment,role,status.
# Đọc máy chủ môi trường prod có tên chứa "web"
export HUB_URL="https://hub.minhan.vn"
export TOKEN="<token vừa cấp>"
curl -s "$HUB_URL/api/v1/servers?environment=prod&search=web" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json" Đường dẫn không có v1 (ví dụ /api/iac/runs) vẫn hoạt động nhưng đã ngừng phát triển; dùng bản có v1 cho mọi tích hợp mới. Một số chức năng không có trên API vì lý do bảo mật: quản lý token, khóa SSO, đăng nhập, mật khẩu và xác thực hai bước.
Xác thực
Token Bearer (Laravel Sanctum) gắn với một người dùng có sẵn và không bao giờ vượt quá quyền và phạm vi công ty của người đó. Khi cấp, có thể bó hẹp thêm quyền, đặt hạn dùng và giới hạn dải IP. Token hiện đúng một lần.
| Header | Khi nào | Giá trị |
|---|---|---|
Authorization | bắt buộc | Bearer <token>, token Sanctum cấp ở Quản trị, Quản lý API |
Accept | bắt buộc | application/json |
Content-Type | khi có body | application/json |
Accept-Language | tùy chọn | vi hoặc en, ngôn ngữ của thông báo lỗi |
X-Company-Id | tùy chọn | Làm việc trong một công ty con được cấp quyền, thay vì công ty của token |
Cảnh báo: bảo vệ token
Không đưa token vào mã nguồn, log hay ticket. Nghi bị lộ thì thu hồi trong Quản lý API rồi cấp token mới.
Phạm vi công ty
Token kế thừa phạm vi công ty của người dùng đại diện. Tài nguyên của công ty khác trả 404, như thể không tồn tại. Gửi X-Company-Id để làm việc trong một công ty con đã được cấp quyền; công ty ngoài phạm vi trả 403 với reason: company_not_allowed.
Giới hạn tốc độ
Mặc định 60 request mỗi phút mỗi token, quản trị viên đặt riêng được cho từng token. Request bằng phiên đăng nhập bị giới hạn 30 request mỗi phút theo IP. Nhóm /monitoring/collector có giới hạn riêng 1.200 request mỗi phút.
Mã lỗi
| Mã | Ý nghĩa |
|---|---|
| 401 | Thiếu token, token sai, hết hạn hoặc đã thu hồi |
| 403 | Thiếu quyền của người dùng hoặc của token, IP không được phép, hoặc reason: company_not_allowed |
| 404 | Không tồn tại, hoặc thuộc công ty khác |
| 422 | Dữ liệu không hợp lệ, chi tiết trong errors theo từng trường |
| 429 | Vượt giới hạn tốc độ, chờ theo header Retry-After |
| 500 | Lỗi ngoài dự kiến. message luôn là câu chung, không lộ SQL hay đường dẫn tệp |
/api/v1/monitoring/licensesCấp license
monitoring.manageGiới hạn trong công ty của tokenLicense là khóa dùng một lần hoặc theo lô để agent enroll với collector. Công ty lấy từ máy chủ được ghim; không ghim thì là công ty của người gọi. Tài khoản cá nhân có một license cố định và không cấp thêm được.
Tham số body
namestringbắt buộcTên gợi nhớ, tối đa 255 ký tự.server_iduuidtùy chọnGhim token vào một máy chủ; token chỉ enroll được agent cho máy đó và công ty của máy đó.collector_iduuidtùy chọnChỉ collector này được chuyển tiếp lời enroll.expires_atdatetimetùy chọnThời điểm hết hạn theo ISO 8601, phải ở tương lai. Bỏ trống thì không hết hạn.max_usesintegertùy chọnSố máy tối đa, từ 1 đến 1000, mặc định 1. Tổng các license nằm trong hạn mức agent của gói.
Phản hồi 201
data.iduuidbắt buộcMã license.data.token_hintstringbắt buộcVài ký tự đầu và cuối của token để nhận ra, ví dụahet_...x9Lk.data.statusenumbắt buộcactive,expired,exhausted,revokedhoặcsuperseded.data.max_uses, data.used_countintegerbắt buộcSố máy được phép enroll và số đã dùng.tokenstringbắt buộcGiá trị token, chỉ có trong phản hồi tạo. Không thể xem lại.
Ghi chú: token chỉ trả một lần
Lưu token ngay khi nhận. Cần khóa mới thì gọi POST /api/v1/monitoring/licenses/{license}/regenerate: khóa cũ ngừng enroll máy mới, agent đã enroll chuyển sang khóa mới khi xoay token.
/api/v1/monitoring/licensesDanh sách license
monitoring.viewGiới hạn trong công ty của tokenMới nhất trước, phân trang 15 bản ghi, giới hạn trong công ty của người gọi. Giá trị token không bao giờ trả về, chỉ có token_hint.
Tham số query
statusenumtùy chọnLọc theo trạng thái:active,expired,exhausted,revoked,superseded.server_iduuidtùy chọnChỉ license ghim vào máy chủ này.searchstringtùy chọnTìm theo tên.pageintegertùy chọn15 bản ghi mỗi trang, mới nhất trước.
/api/v1/monitoring/licenses/{license}Xem một license
monitoring.viewGiới hạn trong công ty của tokenTrả license kèm máy chủ được ghim (tên, hostname). License của công ty khác trả 404.
Tham số đường dẫn
licenseuuidbắt buộcMã license.
/api/v1/monitoring/licenses/{license}Sửa license
monitoring.manageGiới hạn trong công ty của tokenĐổi tên, hạn dùng hoặc số máy. max_uses không được nhỏ hơn số lần đã dùng và tổng của tài khoản vẫn nằm trong hạn mức agent của gói. License đã thu hồi hoặc đã bị thay thế thì không sửa được.
Tham số đường dẫn
licenseuuidbắt buộcMã license.
Tham số body
namestringtùy chọnTên mới, tối đa 255 ký tự.expires_atdatetimetùy chọnHạn mới, phải ở tương lai. Gửinullđể bỏ hạn.max_usesintegertùy chọnSố máy tối đa mới, từ 1 đến 1000.
/api/v1/monitoring/licenses/{license}/regenerateCấp lại khóa
monitoring.manageGiới hạn trong công ty của tokenCấp khóa mới (trả một lần trong token) và cho khóa cũ nghỉ: khóa cũ ngừng enroll máy mới ngay. Agent đã enroll vẫn chạy và chuyển sang khóa mới khi xoay token; agent còn ở khóa cũ sau 30 ngày (migrate_until) bị thu hồi và dữ liệu đã lưu bị xóa.
Tham số đường dẫn
licenseuuidbắt buộcMã license.
/api/v1/monitoring/licenses/{license}/revokeThu hồi license
monitoring.manageGiới hạn trong công ty của tokenToken ngừng hoạt động ngay; agent đã enroll bằng nó không bị ảnh hưởng. Thu hồi license đã thu hồi không làm gì thêm.
Tham số đường dẫn
licenseuuidbắt buộcMã license.
/api/v1/serversDanh sách máy chủ
servers.viewGiới hạn trong công ty của tokenPhân trang 15 bản ghi, sắp theo tên. Với include=health mỗi máy chủ có thêm khối health (connectivity, last_seen_at, open_alerts) đọc từ dữ liệu của Access Hub; khối này cần thêm quyền monitoring.view.
Tham số query
searchstringtùy chọnTìm theo tên, hostname, IP.environmentstringtùy chọnMôi trường, ví dụprod.rolestringtùy chọnVai trò máy chủ, ví dụweb.statusstringtùy chọnTrạng thái vận hành.includestringtùy chọnhealthđể kèm tình trạng giám sát.pageintegertùy chọn15 bản ghi mỗi trang.
/api/v1/servers/{server}/healthSức khỏe máy chủ
monitoring.view, servers.viewGiới hạn trong công ty của tokendata.status là trạng thái trực tiếp từ collector (online, down, unknown), kèm last_seen, giá trị mới nhất của các chỉ số chính và cảnh báo đang mở. data.summary có dạng cố định cho client đơn giản. Khi collector không trả lời được, vẫn là 200 với status null và collector.available = false.
Tham số đường dẫn
serveruuidbắt buộcMã máy chủ.
Phản hồi 200
data.statusenumtùy chọnonline,downhoặcunknown; null khi collector không trả lời.data.summaryobjectbắt buộcconnectivity,cpu_percent,memory_percent,disk_percent(mount/),load1,sampled_at; mỗi trường null khi chưa biết.data.open_alertsarraybắt buộcCảnh báo đang mở của máy chủ.collector.reasonenumtùy chọnunavailable,not_configuredhoặcno_datakhi không có số liệu.
/api/v1/iac/runsNộp yêu cầu IaC
iac.submitGiới hạn trong công ty của tokenNộp 1 đến 25 manifest YAML. Yêu cầu được lập kế hoạch (kiểm tra, so khác biệt, đi qua workflow phê duyệt) rồi lưu lại. Với apply: true và quyền iac.apply, yêu cầu được áp dụng ngay; thiếu quyền thì cờ bị bỏ qua và yêu cầu vẫn ở trạng thái planned.
Tham số body
manifestsarraybắt buộc1 đến 25 phần tử{path, contents}.manifests[].pathstringbắt buộcĐường dẫn quy ước{kind}/{công ty}/{tên}.yml. Đúng ba phần thì cả ba phải khớp nội dung YAML, lệch phần nào cũng bị từ chối.manifests[].contentsstringbắt buộcNội dung YAML thuần.titlestringtùy chọnBỏ trống thì hệ thống tự đặt theo kết quả lập kế hoạch (Onboard ...,Update ...).descriptionstringtùy chọnMô tả, hỗ trợ HTML thuần.applybooleantùy chọntrueđể áp dụng ngay sau khi lập kế hoạch thành công.
Cảnh báo: đang tạm tắt trên một số hub
Khi cài đặt iac.yaml_upload_enabled tắt, endpoint này trả 403. Dùng POST /api/v1/iac/form (biểu mẫu có hướng dẫn) để nộp cùng loại yêu cầu.
/api/v1/iac/runsDanh sách yêu cầu IaC
iac.viewGiới hạn trong công ty của tokenMới nhất trước, phân trang 15 bản ghi, chỉ gồm yêu cầu do người trong công ty của người gọi nộp. Mỗi yêu cầu có files_count và kinds (loại tài nguyên kèm số mục).
Tham số query
searchstringtùy chọnTìm theo mã, tiêu đề, tên người nộp.statusenumtùy chọnplanned,invalid,appliedhoặcpartially-applied.minebooleantùy chọn1để chỉ lấy yêu cầu của người gọi.pageintegertùy chọn15 bản ghi mỗi trang.
/api/v1/iac/runs/{run}Xem yêu cầu IaC
iac.viewGiới hạn trong công ty của tokenTệp, đính kèm, từng mục đã lập kế hoạch với diff và dòng thời gian phê duyệt (luồng, bước, phiếu, đồng hồ SLA). Người nộp luôn xem được yêu cầu của mình. Dùng để theo dõi status, queued_at và apply_error sau khi áp dụng.
Tham số đường dẫn
runuuidbắt buộcMã yêu cầu.
/api/v1/iac/runs/{run}/applyÁp dụng yêu cầu IaC
iac.applyGiới hạn trong công ty của tokenĐưa yêu cầu vào hàng đợi áp dụng và trả 202. Việc áp dụng chạy nền: đọc lại GET /api/v1/iac/runs/{run} để xem status, applied_at, apply_error. Mục chưa đủ phê duyệt không được áp dụng.
Tham số đường dẫn
runuuidbắt buộcMã yêu cầu.
/api/v1/monitoring/alertsDanh sách cảnh báo
monitoring.viewGiới hạn trong công ty của tokenMới nhất trước, phân trang 15 bản ghi. Cảnh báo chỉ do collector tạo; người dùng xác nhận hoặc đóng.
Tham số query
stateenumtùy chọnopen,acknowledged,resolved,closed;activelà mở hoặc đã xác nhận.severitystringtùy chọnMức độ, ví dụcritical.server_iduuidtùy chọnChỉ cảnh báo của máy chủ này.agent_iduuidtùy chọnChỉ cảnh báo của agent này.opened_from, opened_todatetimetùy chọnKhoảng thời gian mở cảnh báo theo ISO 8601, tính cả hai đầu.
/api/v1/monitoring/alerts/{alert}/acknowledgeXác nhận cảnh báo
monitoring.manageGiới hạn trong công ty của tokenChỉ cảnh báo đang mở hoặc đã xác nhận mới xác nhận được (nếu không là 422). Xác nhận hai lần giữ lần đầu. Xác nhận không dừng nhắc lại và không đóng cảnh báo.
Tham số đường dẫn
alertuuidbắt buộcMã cảnh báo.
/api/v1/monitoring/alerts/{alert}/closeĐóng cảnh báo
monitoring.manageGiới hạn trong công ty của tokenĐóng tay một cảnh báo đang mở hoặc đã xác nhận. Collector không được báo: nếu sự cố vẫn còn, sự kiện mở tiếp theo tạo cảnh báo mới.
Tham số đường dẫn
alertuuidbắt buộcMã cảnh báo.
/api/v1/monitoring/collector/enrollEnroll agent bằng License
monitoring.collectorChỉ tài khoản dịch vụ của collectorCollector đổi License lấy token của agent và truyền IP của agent trong X-Forwarded-For. Nhóm /monitoring/collector có giới hạn riêng 1.200 request mỗi phút (biến MONITORING_COLLECTOR_RATE_LIMIT). Từ chối có dạng {"error": {"code", "message"}}.
Mã lỗi
401codeinvalid_token,token_revoked,token_expired.409codetoken_used,already_enrolled.422codebinding_failed.429coderate_limited.
/api/v1/monitoring/collector/agentsRegistry agent
monitoring.collectorChỉ tài khoản dịch vụ của collectorRegistry agent phân trang theo version, gồm cả agent đã thu hồi. Trả next_since và more để collector kéo tiếp. Các endpoint đồng bộ rules, silences dùng cùng cách (mặc định 100, tối đa 500) và kèm tombstone.
Tham số query
sinceintegertùy chọnVersion cuối đã nhận.limitintegertùy chọnMặc định 100, tối đa 1000.
/api/v1/monitoring/collector/eventsGửi sự kiện cảnh báo
monitoring.collectorChỉ tài khoản dịch vụ của collectorGửi tối đa 200 sự kiện đổi trạng thái mỗi lô. Endpoint idempotent theo event_id, gửi lại một lô là vô hại. Heartbeat của collector (POST heartbeat) mang collector_id, version, agent_count, ingest_rps, outbox_depth.
Tham số body
eventsarraybắt buộcTối đa 200 sự kiện, mỗi sự kiện cóevent_idduy nhất.
Mẹo: gợi ý nạp lại là chiều ngược
Ngoài các endpoint này, chính Access Hub gọi API quản trị của collector (POST /internal/v1/reload/rules, .../silences, .../settings) để collector nạp lại ngay. Đó là API của collector, xem tài liệu Collector.
Tất cả endpoint
Danh sách lấy từ bảng route của Access Hub. Endpoint đã có mục riêng ở trên có liên kết tới mục đó. Mô tả từng tham số của các endpoint còn lại xem tại /docs/api-reference trên chính hub của bạn.
Giám sát: license6
- POST
/monitoring/licensesCấp license - GET
/monitoring/licensesDanh sách license - GET
/monitoring/licenses/{license}Xem một license - PATCH
/monitoring/licenses/{license}Sửa license - POST
/monitoring/licenses/{license}/regenerateCấp lại khóa - POST
/monitoring/licenses/{license}/revokeThu hồi license
Máy chủ15
- GET
/serversDanh sách máy chủ - GET
/servers/{server}/healthSức khỏe máy chủ - POSTTạo máy chủ
- DELETEXóa máy chủ
- GETXem máy chủ
- PATCHSửa máy chủ
- PUTSửa máy chủ
- GETChuỗi thời gian sức khỏe
- GETChuỗi thời gian theo lô
- GETXem máy chủ
- POSTÁp dụng kiểm kê vào máy chủ
- POSTXuất máy chủ
- GETThùng rác máy chủ
- DELETEXóa vĩnh viễn máy chủ
- POSTKhôi phục máy chủ
Kết nối12
- GETDanh sách kết nối
- POSTTạo kết nối
- DELETEXóa kết nối
- GETXem kết nối
- PATCHSửa kết nối
- PUTSửa kết nối
- POSTTạo kết nối
- POSTXem trước gia hạn hàng loạt
- POSTXuất kết nối
- GETThùng rác kết nối
- DELETEXóa vĩnh viễn kết nối
- POSTKhôi phục kết nối
F5 Load Balancer30
- GETDanh sách thiết bị F5
- POSTTạo thiết bị F5
- DELETEXóa thiết bị F5
- GETXem thiết bị F5
- PATCHSửa thiết bị F5
- PUTSửa thiết bị F5
- POSTXuất thiết bị F5
- GETThùng rác thiết bị F5
- DELETEXóa vĩnh viễn thiết bị F5
- POSTKhôi phục thiết bị F5
- GETDanh sách pool member F5
- POSTTạo pool member F5
- DELETEXóa pool member F5
- GETXem pool member F5
- PATCHSửa pool member F5
- PUTSửa pool member F5
- POSTXuất pool member F5
- GETThùng rác pool member F5
- DELETEXóa vĩnh viễn pool member F5
- POSTKhôi phục pool member F5
- GETDanh sách virtual port F5
- POSTTạo virtual port F5
- DELETEXóa virtual port F5
- GETXem virtual port F5
- PATCHSửa virtual port F5
- PUTSửa virtual port F5
- POSTXuất virtual port F5
- GETThùng rác virtual port F5
- DELETEXóa vĩnh viễn virtual port F5
- POSTKhôi phục virtual port F5
Proxy20
- GETDanh sách proxy
- POSTTạo proxy
- DELETEXóa proxy
- GETXem proxy
- PATCHSửa proxy
- PUTSửa proxy
- POSTXuất proxy
- GETThùng rác proxy
- DELETEXóa vĩnh viễn proxy
- POSTKhôi phục proxy
- GETDanh sách đích proxy
- POSTTạo đích proxy
- DELETEXóa đích proxy
- GETXem đích proxy
- PATCHSửa đích proxy
- PUTSửa đích proxy
- POSTXuất đích proxy
- GETThùng rác đích proxy
- DELETEXóa vĩnh viễn đích proxy
- POSTKhôi phục đích proxy
Chứng chỉ SSL22
- GETDanh sách gắn chứng chỉ
- POSTTạo gắn chứng chỉ
- DELETEXóa gắn chứng chỉ
- GETXem gắn chứng chỉ
- PATCHSửa gắn chứng chỉ
- PUTSửa gắn chứng chỉ
- POSTXuất gắn chứng chỉ
- GETThùng rác gắn chứng chỉ
- DELETEXóa vĩnh viễn gắn chứng chỉ
- POSTKhôi phục gắn chứng chỉ
- GETDanh sách chứng chỉ SSL
- POSTTạo chứng chỉ SSL
- DELETEXóa chứng chỉ SSL
- GETXem chứng chỉ SSL
- PATCHSửa chứng chỉ SSL
- PUTSửa chứng chỉ SSL
- POSTTạo chứng chỉ SSL
- POSTXem trước gia hạn hàng loạt
- POSTXuất chứng chỉ SSL
- GETThùng rác chứng chỉ SSL
- DELETEXóa vĩnh viễn chứng chỉ SSL
- POSTKhôi phục chứng chỉ SSL
Yêu cầu IaC15
- POST
/iac/runsNộp yêu cầu IaC - GET
/iac/runsDanh sách yêu cầu IaC - GET
/iac/runs/{run}Xem yêu cầu IaC - POST
/iac/runs/{run}/applyÁp dụng yêu cầu IaC - GETMô tả biểu mẫu IaC
- POSTNộp yêu cầu từ biểu mẫu
- GETTìm bản ghi để tham chiếu
- DELETEXóa yêu cầu IaC
- POSTXuất yêu cầu IaC
- GETThùng rác yêu cầu IaC
- DELETEXóa vĩnh viễn yêu cầu IaC
- POSTKhôi phục yêu cầu IaC
- GETDanh sách mẫu manifest
- GETXem mẫu manifest
- GETTải tệp
Hộp thư duyệt5
- POSTDuyệt hoặc từ chối một bước
- GETLịch sử
- GETViệc chờ duyệt
- GETXem
- GETViệc cần chú ý
Quy trình duyệt21
- GETDanh sách quy trình duyệt
- POSTTạo quy trình duyệt
- DELETEXóa quy trình duyệt
- GETXem quy trình duyệt
- PATCHSửa quy trình duyệt
- PUTSửa quy trình duyệt
- GETSơ đồ quy trình
- GETTìm phiên bản quy trình
- GETTìm người duyệt
- GETTùy chọn cho biểu mẫu
- GETXem trước chuyển giao
- POSTChuyển giao bước đang chờ
- GETThùng rác quy trình duyệt
- DELETEXóa vĩnh viễn quy trình duyệt
- POSTKhôi phục quy trình duyệt
- GETDanh sách lịch làm việc
- POSTTạo lịch làm việc
- DELETEXóa lịch làm việc
- GETXem lịch làm việc
- PATCHSửa lịch làm việc
- PUTSửa lịch làm việc
Danh tính và phân quyền54
- GETDanh sách công ty
- POSTTạo công ty
- DELETEXóa công ty
- GETXem công ty
- PATCHSửa công ty
- PUTSửa công ty
- GETThùng rác công ty
- DELETEXóa vĩnh viễn công ty
- POSTKhôi phục công ty
- GETSơ đồ tổ chức
- GETDanh sách quyền
- GETDanh sách vai trò
- POSTTạo vai trò
- DELETEXóa vai trò
- GETXem vai trò
- PATCHSửa vai trò
- PUTSửa vai trò
- GETThùng rác vai trò
- DELETEXóa vĩnh viễn vai trò
- POSTKhôi phục vai trò
- GETDanh sách công ty con
- POSTTạo công ty con
- DELETEXóa công ty con
- GETXem công ty con
- PATCHSửa công ty con
- PUTSửa công ty con
- GETQuyền đã cấp cho công ty con
- POSTCấp quyền cho công ty con
- DELETEThu hồi quyền của công ty con
- GETDanh sách nhóm người dùng
- POSTTạo nhóm người dùng
- DELETEXóa nhóm người dùng
- GETXem nhóm người dùng
- PATCHSửa nhóm người dùng
- PUTSửa nhóm người dùng
- GETThùng rác nhóm người dùng
- DELETEXóa vĩnh viễn nhóm người dùng
- POSTKhôi phục nhóm người dùng
- GETDanh sách người dùng
- POSTTạo người dùng
- DELETEXóa người dùng
- GETXem người dùng
- PATCHSửa người dùng
- PUTSửa người dùng
- POSTKích hoạt người dùng
- POSTVô hiệu hóa người dùng
- DELETEGỡ liên kết đăng nhập ngoài
- POSTMở khóa xác thực hai bước
- POSTGán hàng loạt
- POSTXem trước gán hàng loạt
- GETTìm người quản lý
- GETThùng rác người dùng
- DELETEXóa vĩnh viễn người dùng
- POSTKhôi phục người dùng
Thông báo13
- GETDanh sách nhật ký thông báo
- POSTGửi lại thông báo
- GETDanh sách tùy chọn thông báo
- PUTSửa tùy chọn thông báo
- GETDanh sách mẫu thông báo
- GETXem mẫu thông báo
- PUTSửa mẫu thông báo
- POSTKhôi phục mẫu gốc
- GETDanh sách thông báo
- DELETEXóa thông báo
- POSTĐánh dấu đã đọc
- POSTĐánh dấu tất cả đã đọc
- GETSố thông báo chưa đọc
Webhook9
- GETDanh sách kênh webhook
- POSTTạo kênh webhook
- DELETEXóa kênh webhook
- GETXem kênh webhook
- PUTSửa kênh webhook
- GETLần gửi webhook
- GETDanh sách kênh webhook
- POSTChạy lại kênh webhook
- GETTùy chọn cho biểu mẫu
Giám sát: agent5
- GETDanh sách agent
- DELETEXóa agent
- GETXem agent
- POSTGắn lại máy chủ cho agent
- POSTThu hồi agent
Giám sát: cảnh báo4
- GET
/monitoring/alertsDanh sách cảnh báo - POST
/monitoring/alerts/{alert}/acknowledgeXác nhận cảnh báo - POST
/monitoring/alerts/{alert}/closeĐóng cảnh báo - GETXem cảnh báo
Giám sát: kiểm tra chủ động7
- GETDanh sách kiểm tra chủ động
- POSTTạo kiểm tra chủ động
- DELETEXóa kiểm tra chủ động
- GETXem kiểm tra chủ động
- PUTSửa kiểm tra chủ động
- POSTTắt kiểm tra chủ động
- POSTBật kiểm tra chủ động
Ứng dụng di động6
- GETDanh sách thiết bị
- POSTTạo thiết bị
- DELETEXóa thiết bị
- POSTĐăng nhập ứng dụng di động
- POSTĐăng xuất ứng dụng di động
- POSTXác thực hai bước
Giám sát: luật10
- GETDanh sách luật
- POSTTạo luật
- DELETEXóa luật
- GETXem luật
- PUTSửa luật
- POSTTắt luật
- POSTNhân bản luật
- POSTBật luật
- POSTTạo luật mặc định
- POSTpreview luật
Giám sát: silence6
- GETDanh sách silence
- POSTTạo silence
- DELETEXóa silence
- GETXem silence
- PUTSửa silence
- POSTKết thúc silence ngay
Giám sát: tổng quan và cài đặt3
- GETTổng quan giám sát
- GETXem cài đặt giám sát
- PUTSửa cài đặt giám sát
Giám sát: endpoint cho collector11
- POST
/monitoring/collector/enrollEnroll agent bằng License - GET
/monitoring/collector/agentsRegistry agent - POST
/monitoring/collector/eventsGửi sự kiện cảnh báo - POSTGia hạn token agent
- POSTBáo lần thấy agent
- GETKiểm tra chủ động cần chạy
- POSTHeartbeat của collector
- POSTGửi kiểm kê máy chủ
- GETĐồng bộ luật
- GETTham số gom sự cố
- GETĐồng bộ silence
Tên miền và DNS20
- GETDanh sách bản ghi DNS
- POSTTạo bản ghi DNS
- DELETEXóa bản ghi DNS
- GETXem bản ghi DNS
- PATCHSửa bản ghi DNS
- PUTSửa bản ghi DNS
- POSTXuất bản ghi DNS
- GETThùng rác bản ghi DNS
- DELETEXóa vĩnh viễn bản ghi DNS
- POSTKhôi phục bản ghi DNS
- GETDanh sách tên miền
- POSTTạo tên miền
- DELETEXóa tên miền
- GETXem tên miền
- PATCHSửa tên miền
- PUTSửa tên miền
- POSTXuất tên miền
- GETThùng rác tên miền
- DELETEXóa vĩnh viễn tên miền
- POSTKhôi phục tên miền
Subnet, IP và sơ đồ mạng21
- GETDanh sách IP công khai
- POSTTạo IP công khai
- DELETEXóa IP công khai
- GETXem IP công khai
- PATCHSửa IP công khai
- PUTSửa IP công khai
- POSTXuất IP công khai
- GETThùng rác IP công khai
- DELETEXóa vĩnh viễn IP công khai
- POSTKhôi phục IP công khai
- GETDanh sách subnet
- POSTTạo subnet
- DELETEXóa subnet
- GETXem subnet
- PATCHSửa subnet
- PUTSửa subnet
- POSTXuất subnet
- GETThùng rác subnet
- DELETEXóa vĩnh viễn subnet
- POSTKhôi phục subnet
- GETSơ đồ mạng
Danh mục tùy chọn7
- GETCác loại danh mục
- GETGiá trị của một danh mục
- POSTTạo danh mục tùy chọn
- DELETEXóa danh mục tùy chọn
- GETXem danh mục tùy chọn
- PATCHSửa danh mục tùy chọn
- PUTSửa danh mục tùy chọn
Hàng đợi9
- GETDanh sách hàng đợi
- DELETEXóa job lỗi
- GETJob lỗi
- DELETEXóa hàng đợi
- POSTChạy lại hàng đợi
- POSTChạy lại mọi job lỗi
- GETLịch sử
- POSTTạm dừng làn hàng đợi
- POSTChạy tiếp làn hàng đợi
Lệnh hệ thống7
- GETDanh sách lệnh hệ thống
- GETXem lệnh hệ thống
- POSTChạy lệnh
- GETLần chạy của lệnh
- DELETEXóa lịch chạy
- POSTĐặt lịch chạy
- PUTSửa lịch chạy
Cài đặt hệ thống7
- GETTổng quan nền tảng
- GETXem cài đặt chung
- PUTSửa cài đặt chung
- GETXem cài đặt lưu trữ
- PUTSửa cài đặt lưu trữ
- GETXem cài đặt bảo mật
- PUTSửa cài đặt bảo mật
Nhật ký kiểm toán4
- GETDanh sách nhật ký kiểm toán
- GETXem nhật ký kiểm toán
- GETTìm người thực hiện
- POSTXuất báo cáo tuân thủ
Xuất dữ liệu4
- POSTXuất dữ liệu tài khoản
- GETDanh sách bản xuất
- GETXem bản xuất
- GETTải tệp
Tài khoản của tôi8
- GETXem cài đặt tài khoản
- PUTSửa cài đặt tài khoản
- GETThông tin người dùng hiện tại
- GETDanh sách tài khoản
- POSTĐặt tài khoản mặc định
- POSTNhận lời mời
- POSTTừ chối lời mời
- GETGói dịch vụ hiện tại
Tìm kiếm, dashboard, tệp3
- GETTải tệp
- GETSố liệu dashboard
- GETTìm kiếm toàn hệ thống