Endpoint index
Every endpoint and command in one place: dock's API under /api/dock/v1, the XPLG product's URL API under /logeye, the ingest endpoint and the SDK commands, each with its authentication and the page that documents it.
What you will do: find the call you need and the page that documents it.
dock API — https://dock.xplg.com/api/dock/v1
| Endpoint | Purpose | Authentication | Page |
|---|---|---|---|
POST /deployments/heartbeat | Register a deployment on first contact; report version and usage meters afterwards | License key on first contact, then the deployment token (xdk_…) | Heartbeat API (sign in to read) |
GET /license/status | Plan versus actual, XMC balance, forecast, alerts | Deployment token or a signed-in session | License status API (sign in to read) |
GET /pricing/catalog | The price book in force, as the caller may see it | Optional session | Overview and authentication |
POST /pricing/quote | Price an offer state with the engine | Optional session; channel from the caller's profile | Overview and authentication |
POST, GET /offers/<id>/attachments | Upload and list collateral on an offer | Session | Overview and authentication |
GET /offers/<id>/attachments/<attachmentId> | Download one attachment | Session | Overview and authentication |
GET /api/dock/health, GET /api/healthcheck | Health summary of the portal; the liveness probe | None for the summary; operator token for the detail | Overview and authentication |
Usage is read in the workspace and through the license status report — see Usage (sign in to read). Webhooks and API keys with scopes are planned — see Webhooks (sign in to read).
XPLG product URL API — http(s)://<host>:<port>/logeye
Port 30303 or 30443 on V7, the ui role's port or the edge on X8. With security active, every read call signs in with &autoLogin=true&username=<user>&password=<password>.
| Endpoint | Purpose | Page |
|---|---|---|
GET /view/api/widgetAPI.jsp?widgetId=searchAPI&… | Run a search; XML or CSV, pagination, limits | XpoLog search API |
GET /view/api/dashboardAPI.jsp?action=export&appName=…&viewName=… | A dashboard's latest result as PDF | XpoLog search API |
GET /search/view/loadSearchModel.jsp?searchQuery=… | Open the Search console on a query | XpoLog search API |
GET /message/messageJsonApi.jsp?api=collectedDataInfo&… | Defined and collected logs per folder or AppTag; uncollected logs with sizes | Configuration API |
GET /restapi/folders-and-logs-configuration?sourceQuery=… | The Folders and Logs tree | Configuration API |
GET /restapi/log-configuration?logPath=…&logName=… | One log's definition | Configuration API |
GET /restapi/logs-configuration?sourceQuery=… | Many logs' definitions, pipe-delimited | Configuration API |
POST /api/logger.jsp?token=…&hostName=… | Ingest a JSON event through an HTTP/S listener; the token authenticates | PortX ingest HTTP API |
SDK commands — xpologClient.jar
-xpologURL <url>/logeye -user <user> -password <password> -api <command>; see SDK and CLI reference.
| Area | Commands |
|---|---|
| Settings and security | settings (ports, Agent Mode, security, time-zone mode, AppTag time zones), securityUsers |
| Accounts | addSSHAccount, addRemoteXpoLogAccount, addExternalAccount (S3), enableAccount, removeAccount |
| Tasks | executeTask, executeScanTask, addScanTask, addSyncLogTask |
| Folders and logs | addLog (files, SSH, Remote XPLG, Windows Event Logs), addFolder, removeMember |
| Lifecycle | license, restart, addPatch; the command-line update package applyPatch.sh / applyPatch.bat |
Not available yet
- A token or API key for the product URL API, and its rate limits — pending engineering.
- Payload limits and throttling of the HTTP/S listener — pending engineering.
- REST write endpoints on the product — none documented; use the SDK.
- dock: API keys with scopes, a usage read endpoint and webhooks — planned.
Next: Users and roles (sign in to read)
Source: XPLG wiki, pages 1594753063, 1597014018, 1598685520, 1597014014 (https://xpolog.atlassian.net/wiki/spaces/XPOL/pages/1597014014); dock API routes under apps/web/app/api/dock/v1.
