Qodex.ai

DataSet API Collection

Number of APIs: 32

You can use the DataSet API to send and retrieve log data, archive events, and manage configuration files, users, and groups.

There are many ways to get data in. See our data model in the Getting Started guide. We also have a Java client library, and a command-line tool. If you want to talk directly to the servers in a language other than Java, this page is for you.

Authentication

Access to the DataSet API is via API keys. You must generate a key to access the API. There are four types: Log Read Access, Log Write Access, Configuration Read Access, and Configuration Write Access. The instructions for each method show which key is required.

Authentication can happen in two ways:

  1. Token the body of a POST request {"token":"{token}"}
  2. Send the API key in a request by adding Authorization: Bearer {token} to the header

Response

The response always includes a status property. If the request is a success the value is success. Status values have slash-delimited components. For example, success/noSuchFile shows that the request is a success, but the specified file does not exist. Both error/client and error/server are failed operations, but one is the client's fault, and the other is the server's.

  1. Manage Groups - editGroupPermission POST {{app_url}}/api/editGroupPermissions

  2. Query Data - query POST {{app_url}}/api/query

  3. Query Data - powerQuery POST {{app_url}}/api/powerQuery

  4. Manage Users - inviteUser POST {{app_url}}/api/inviteUser

  5. Query Data - timeseriesQuery POST {{app_url}}/api/timeseriesQuery

  6. Manage Files - getFile POST {{app_url}}/getFile

  7. Query Data - facetQuery POST {{app_url}}/api/facetQuery

  8. Archive Data - create log-archive-rules POST {{app_url}}/v2/api/log-archive-rules

  9. Ingest Data - addEvents POST {{app_url}}/api/addEvents

  10. Manage Users - revokeAccess POST {{app_url}}/api/revokeAccess