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/serverinfo' -s {"license":"Pulse License: FREE - 3 users expires 2023-05-14","licensePro":false,"licenseDaysLeft":50,"version":"0.15.3","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://guest:pass@localhost:8080/api/a.csv/DEMODB' --data-raw 'SELECT TIME,NAME,ASK,((user)) AS USER FROM QUOTE LIMIT 2' -s TIME,NAME,ASK,USER 2023-03-23 18:02:10.656,OKTA,269.98,guest 2023-03-23 18:02:10.658,TWLO,385.24,guest $ curl 'http://admin:pass@localhost:8080/api/a.csv/DEMODB' --data-raw 'SELECT TIME,NAME,ASK,((user)) AS USER FROM QUOTE LIMIT 2' -s TIME,NAME,ASK,USER 2023-03-23 18:02:10.656,OKTA,269.98,admin 2023-03-23 18:02:10.658,TWLO,385.24,admin $ curl 'http://api_key:ef003741-bc43-467f-b9ba-bd0d85e38441@localhost:8080/api/a.csv/DEMODB' --data-raw 'SELECT TIME,NAME,ASK,((user)) AS USER FROM QUOTE LIMIT 2' -s TIME,NAME,ASK,USER 2023-03-23 18:02:10.656,OKTA,269.98,admin 2023-03-23 18:02:10.658,TWLO,385.24,admin $ curl 'http://localhost:8080/api/a.csv/DEMODB' --data-raw 'SELECT TIME,NAME,ASK,((user)) AS USER FROM QUOTE LIMIT 2' -s -u api_key:ef003741-bc43-467f-b9ba-bd0d85e38441 TIME,NAME,ASK,USER 2023-03-23 18:02:10.656,OKTA,269.98,admin 2023-03-23 18:02:10.658,TWLO,385.24,admin

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" ""