REST API and API keys
Automate documentation with the REST API, using keys that only do what you allow.
The REST API lets scripts and other tools read and write your documentation: sync from an RMM, create assets from a provisioning script, or pull passwords into automation.
Create an API key
Only admins create keys (Manage users, roles and teams).
- Go to Admin → AI & API → + New API key.
- Name the key, for example RMM sync, and choose who it acts as. The key can never do more than that person, and its changes are recorded under their name.
- Choose what the key can reach:
| Setting | Options |
|---|---|
| Organizations | All, or only chosen ones |
| Each resource | Organizations, assets, flexible assets, documents, contacts, domains, search: No access, Read or Read & write |
| Passwords | No access, Read (no secrets), Read & reveal or Read, reveal & write |
| Asset types | Every asset type, or only chosen ones |
| Flexible asset types | Every type, or only chosen ones |
- Choose Create key and copy the key now. It's only shown once.
Change a key's permissions later by opening it from the list. You don't need to issue a new key. Revoke stops a key working immediately. People can see and revoke the keys that act as them under Profile → My API keys.
Make requests
Send the key as a bearer token, to your workspace's address:
curl -H "Authorization: Bearer kp_…" https://yourcompany.knowpoint.io/api/v1/organizations
curl -X POST -H "Authorization: Bearer kp_…" -H "Content-Type: application/json" \
-d '{"organization_id": 1, "asset_type": "Workstation", "name": "FRONTDESK-01", "fields": {"serial_number": "5CG1234"}}' \
https://yourcompany.knowpoint.io/api/v1/assets
The interactive reference, with every endpoint and field, is at /api/docs on your workspace's address.
What the API covers
| Resource | Endpoints |
|---|---|
| Organizations | List, get, create, update |
| Asset types | List |
| Assets | List per organization, get, create, update, delete |
| Flexible assets | List types, list per organization, get, create, update, delete |
| Documents | List, get, create, update |
| Contacts | List per organization, create |
| Passwords | List per organization, get, create. Add ?include_secret=true to get the password (needs reveal access, and is audited). |
| Domains | List per organization, get, add (looked up straight away), refresh |
| Tags, search | List tags, search everything |
Good to know
- A key follows the same rules as a person: organization access, restricted items and role permissions all apply.
- Asking for something the key isn't allowed returns 403 with an explanation. Items it can't see return 404.
- Every change made through the API is in the audit log as "API: …".
Didn't find what you needed? Email us about this page