Key Configuration

A MASTER_API_KEY can be specified as part of the Admin Configuration. We recommend using an online UUID generator.

#Windows SET MASTER_API_KEY=ef003741-bc43-467f-b9ba-bd0d85e38441 #Linux export MASTER_API_KEY=ef003741-bc43-467f-b9ba-bd0d85e38441

API REST Calls

CURL Examples

The simplest example is a call for which no authentication is required. For example:

$ curl http://localhost:8080/api/admin/serverinfo -s {"license":"Pulse Pro License: pro - 3 users expires 2026-03-14","licensePro":true,"licenseDaysLeft":369,"licenseUser":"pro","version":"3.14","licensedUsers":3}

Fetching CSV SQL Query Results

To authenticate calls as using HTTP basic authentication either:

• Pass the username:password of a selected user
• Pass the username api_key with the password MASTER_API_KEY as set in Admin Configuration

$curl 'http://admin:pass@localhost:8080/api/a.csv/DEMODB' -X POST --data-raw 'SELECT NOW() AS N,RAND() AS r,((USER)) as u;' -s N,R,U 2025-03-09 11:39:04.85726,0.820602037895467,admin $curl 'http://api_key:ef003741-bc43-467f-b9ba-bd0d85e38441@localhost:8080/api/a.csv/DEMODB' -X POST --data-raw 'SELECT NOW() AS N,RAND() AS r,((USER)) as u;' -s N,R,U 2025-03-09 11:40:26.182558,0.38069302229415924,admin $ curl 'http://localhost:8080/api/a.csv/DEMODB' --data-raw 'SELECT NOW() AS N,RAND() AS r,((USER)) as u;' -s -u api_key:ef003741-bc43-467f-b9ba-bd0d85e38441 N,R,U 2025-03-09 11:41:04.078449,0.33419673954684215,admin

Setting User Permissions via API

Action	url	Method	Content Type
get team details	/api/team/list-private/{teamName}	GET
Add user to team	/api/team/role	POST	application/json
Delete a single Role	/api/team/role/{roleId}	DELETE

The code example below demonstrates:

1. Liting the details of a team named dataisbeautiful. Showing one user named spez in the team.
2. Successfully adding the VIEWER role for user guest to the team dataisbeautiful.
3. Failing to add a role for a user to a team because the user is already assigned a role.
4. Listing the details of a team named dataisbeautiful. Showing two members in the team, spez and guest.
5. Deleting the role linking guest to the team. Using the roleId.
6. Liting the details of a team named dataisbeautiful. Showing one user named spez in the team.

$ curl 'http://admin:pass@localhost:8080/api/team/list-private/dataisbeautiful' -s [{"id":1,"bio":null,"dateCreated":1741518927517,"dateUpdated":1741518927517,"name":"spez","userRole":"EDITOR","starCount":0,"twitter":null,"teamRole":"ADMIN","origin":"user: spez"}] $ curl 'http://admin:pass@localhost:8080/api/team/role' -X POST --data-raw '{"userName":"guest","teamName":"dataisbeautiful","roleType":"VIEWER"}' -H 'Content-Type: application/json' -s {"id":9,"bio":null,"dateCreated":1741522374089,"dateUpdated":1741522374089,"name":"guest","userRole":"VIEWER","starCount":0,"twitter":null,"teamRole":"VIEWER","origin":"user: admin"} $ curl 'http://admin:pass@localhost:8080/api/team/role' -X POST --data-raw '{"userName":"guest","teamName":"dataisbeautiful","roleType":"VIEWER"}' -H 'Content-Type: application/json' -s {"message":"Internal Server Error","logref":null,"path":null,"_embedded":{"errors":[{"message":"Internal Server Error: User is already in team.","logref":null,"path":null,"_embedded":{},"_links":{}}]},"_links":{"self":{"href":"/api/team/role","templated":false,"profile":null,"deprecation":null,"title":null,"hreflang":null,"type":null,"name":null}}} $ curl 'http://admin:pass@localhost:8080/api/team/list-private/dataisbeautiful' -s [{"id":1,"bio":null,"dateCreated":1741518927517,"dateUpdated":1741518927517,"name":"spez","userRole":"EDITOR","starCount":0,"twitter":null,"teamRole":"ADMIN","origin":"user: spez"}, {"id":9,"bio":null,"dateCreated":1741522374089,"dateUpdated":1741522374089,"name":"guest","userRole":"VIEWER","starCount":0,"twitter":null,"teamRole":"VIEWER","origin":"user: admin"}] $ curl 'http://admin:pass@localhost:8080/api/team/role/9' -X DELETE -s $ curl 'http://admin:pass@localhost:8080/api/team/list-private/dataisbeautiful' -s [{"id":1,"bio":null,"dateCreated":1741518927517,"dateUpdated":1741518927517,"name":"spez","userRole":"EDITOR","starCount":0,"twitter":null,"teamRole":"ADMIN","origin":"user: spez"}]

Setting Data Connections via API

Some users will dynamically spin up database instances on new cloud machines throughout the day and may want token_get_all make these accessible in Pulse. The upsert-conns REST API can be used to upsert new connections. As you can see below, each line sent is a separate server in the format: name@host:port:username:password where only host:port are compulsory.

The result returned is one line per server entry sent. Saying whether the server was updated/saved or unchanged. If there is an error, e.g. an incorrect format is sent, that will also be reported.

$ curl 'http://admin:pass@localhost:8080/api/dbserver/upsert-conns' --data-raw $'devA@localhost:5000\nprodA@localhost:6000' -s updated updated $ curl 'http://admin:pass@localhost:8080/api/dbserver/upsert-conns' --data-raw $'devA@localhost:5003\nprodA@localhost:6000\nprodB@localhost:7000:admin:mypass' -s updated unchanged added $ curl 'http://admin:pass@localhost:8080/api/dbserver/upsert-conns' --data-raw $'devA@localhost:5003\nprodA@localhost:6000\nprodB@localhost:7000:admin:mypass' -s unchanged unchanged unchanged

Calling REST API from kdb

q).Q.hp["http://admin:pass@localhost:8080/api/dbserver/upsert-conns";.h.ty`txt;"devbox@localhost:4000\n"] "added\n" q).Q.hp["http://admin:pass@localhost:8080/api/dbserver/upsert-conns";.h.ty`txt;"devbox@localhost:4000\nprodbox@localhost:9000:u:p"] "unchanged\nadded\n" q)"\n" vs .Q.hp["http://admin:pass@localhost:8080/api/dbserver/upsert-conns";.h.ty`txt;"devbox@localhot:4000\nprodbox@localhost:9000:u:p"] "unchanged" "unchanged" "" q)"\n" vs .Q.hp["http://admin:pass@localhost:8080/api/dbserver/upsert-conns";.h.ty`txt;"devbox@localhot:4000\nprodbox@localhost:9002:u:p"] "unchanged" "updated" ""