OctoWatch REST API
Connect OctoWatch Cloud data to the systems your team already runs. Authenticate with JWT, then work with users, reports, activity, Risks, and monitoring channels over REST.
Overview
Once OctoWatch is collecting activity, productivity, and DLP data on Windows endpoints, many teams need that same information outside the Web Console—in a BI tool, a ticket queue, or an onboarding workflow.
The Cloud REST API is for Web Console administrators who need that access programmatically. Sign in with the same administrator credentials you use in the console, receive a JWT, and call the endpoints documented at app.octowatchdlp.com/api/. That site is the live reference, with parameters, sample responses, and curl examples. This page is a short overview for buyers and developers evaluating the integration.
At a Glance
Start here before you open the interactive reference: base URL, how auth works, and a minimal curl sequence.
Base URL
https://app.octowatchdlp.com/api/
Authentication
JWT access and refresh tokens (Bearer)
Access
Web Console administrator credentials
Responses
JSON (curl samples in the interactive docs)
# 1) Get a JWT (confirm parameters in the interactive docs) curl "https://app.octowatchdlp.com/api/Access/login-jwt?email=admin@example.com&password=***" # 2) Call an endpoint with Token from the response curl -H "Authorization: Bearer <Token>" \\ -H "Accept: application/json" \\ "https://app.octowatchdlp.com/api/…"
Exact paths and fields are in the interactive API reference. Protect tokens the way you would any administrator password, and use administrator accounts only where the integration needs them.
What the API Covers
Most endpoints mirror what you already see in the Web Console, so you can map an integration to familiar modules.
Auth
Authentication
Sign in with Web Console administrator credentials to receive a JWT (Token) and RefreshToken, then call other endpoints with an Authorization: Bearer header.
Directory
Users & agents
Create, move, block, and merge users; manage groups, permissions, computers, and Grabbers.
Config
Profiles & categories
Work with Settings, Rules, Timetable, and Computer profiles, and with the productivity categories used in analytics.
Analytics
Activity & timesheets
Pull overview analytics, activity and Chrono data, and timesheet records for payroll, capacity planning, or management reporting.
Security
Risks & reports
Read Risks raised by Rules Profile hits, and run or retrieve reports and background jobs for scheduled or on-demand export.
Channels
Monitoring data
Read email and IM, files, screenshots and video, Live view sessions, search, clipboard, print, webcam, and network data.
Typical Use Cases
Common ways teams use the API alongside the Web Console—not as a replacement for it.
BI & custom dashboards
Send activity, productivity, and timesheet data into internal analytics or management reports without exporting from the console by hand.
Security operations
Bring Risks and related detail into the incident tickets or investigation process your security or IT team already uses.
Directory & lifecycle automation
Keep the user and group tree, blocked users, and Grabber inventory in sync with your onboarding and offboarding process.
Compliance evidence & reports
Generate or download reports and background job results so managers and auditors can review monitoring summaries and rule-hit history in the systems they already use.
How to Get Started
From a Cloud account to your first authenticated request.
2
Authenticate with JWT
Call login-jwt with your administrator email and password. The reply includes Token, RefreshToken, and PublicID (needed to refresh the session).
3
Call the resources you need
Send Authorization: Bearer <Token> on later requests. Use the interactive docs for each endpoint’s parameters and sample replies.
Need help with an integration? Email support@octowatchdlp.com or use the contact form. For install steps and console usage, see the User Guide.
Related
What the API includes—and what it does not
| Includes | Not included |
|---|---|
| JWT-authenticated REST endpoints | No live UI replacement: the Web Console remains the configuration and investigation workspace. |
| Data mapped to Web Console modules | No VNC/remote-desktop control API. |
| Risks and exportable reports | No real-time push streaming without your integration logic (polling/export is expected). |
| Monitoring channel data (email/IM, files, screenshots & videos, live sessions, search, clipboard, prints, webcam, network) | No phone GPS/mobile apps or geofence clock-in. |
API FAQ
What is the OctoWatch REST API for?
To access OctoWatch Cloud data programmatically: users, reports, activity, Risks, and monitoring channels that you also see in the Web Console.
What do I need to start?
You need an OctoWatch Cloud account plus the same Web Console administrator credentials to request a JWT.
How does authentication work?
Use login-jwt to receive Token/RefreshToken, then call endpoints with Authorization: Bearer <Token>.
Can I use this API endpoint for On-Premise?
This landing page documents the OctoWatch Cloud API at https://app.octowatchdlp.com/api/. If you deploy On-Premise, your integration should align with that environment’s available endpoints.
Does the API replace the Web Console?
No. Use the API to integrate data into your own systems; the Web Console stays the main place to configure Profiles, Rules, and investigate Risks.
Where do I find exact parameters and sample replies?
In the interactive API reference linked from this page: app.octowatchdlp.com/api/.