What the REST API integration does
Build on DokLocker: read and update documentation from your own scripts, tools and AI assistants.
Setting it up
Send the token in a header: Authorization: Bearer mdk_…. Data goes in and out as JSON.
| Call | What it does |
|---|---|
GET /api/v1/ |
Who you are, and every endpoint |
GET /api/v1/search/?q=10.0.0.1 |
Search everything |
GET /api/v1/lookup/?number=603.555.0142 |
Who is calling: contacts, clients, sites and records with that phone number, however it was typed, with links |
GET /api/v1/clients/ |
All clients |
GET /api/v1/clients/<id>/ |
One client with its sites, contacts and records |
POST /api/v1/clients/ |
Add a client: {"name": "Acme", "address": "…"} |
POST /api/v1/sites/ |
Add a site: {"client_id": 1, "name": "Warehouse"} |
GET /api/v1/record-types/ |
Record types and their field keys |
GET /api/v1/records/<id>/ |
One record (passwords hidden) |
POST /api/v1/records/ |
Add a record: {"site_id": 1, "type": "printer", "name": "Front Desk", "fields": {"ip_address": "10.0.0.50"}} |
PATCH /api/v1/records/<id>/ |
Change a record's name, notes or fields |
POST /api/v1/records/<id>/reveal/<field>/ |
Read a password (needs a token that can read passwords) |
POST /api/v1/contacts/ |
Add a contact |
GET /api/v1/notes/<id>/, POST /api/v1/notes/ |
Read or add a note |
GET /api/v1/articles/<id>/, POST /api/v1/articles/ |
Read or add a knowledge base article: {"title": "…", "body": "Markdown", "folder": "…"} (search finds articles too) |
GET /api/v1/tiles/?client_id=1 |
A client's status tiles, built-in and posted |
POST /api/v1/tiles/ |
Add or update a status tile (see below) |
DELETE /api/v1/tiles/<id>/ |
Remove a status tile you posted |
GET /api/v1/backups/?client_id=1 |
A client's backup jobs and their last result |
POST /api/v1/backups/ |
Report backup results (see Backup status) |
Example with curl:
curl -H "Authorization: Bearer mdk_…" https://docs.yourcompany.com/api/v1/search/?q=acme
Included in every plan
Every integration is included at no extra cost, on the hosted service and self-hosted. Connect it under Admin › Integrations, click Test, and the first sync starts straight away.