Data Warehouse API Overview
The Kaseya Data Warehouse API comprises a set of client-initiated HTTP URI requests that return corresponding responses from a specified Kaseya Server.
The Kaseya REST API enables 3rd party applications like a Business Intelligence (BI) platforms (Microsoft PowerBI, Tableau) to integrate with the Kaseya Server and get data from Info Center's datasets in a structured JSON-format based on OData standard.
The OData Protocol is an application-level protocol for interacting with data via RESTful interfaces. The protocol supports the description of data models and the editing and querying of data according to those models.
Resource URIs
Supported URIs are used to access resources. The basic format shown in documentation is:
GET /AgentProcedureStatuses
GET is the HTTP method.
AgentProcedureStatuses is the resource URI.;
When you enter the complete format in your browser, the URI looks like this:
https://<yourVSA server domain>/api/odata/v1.0/AgentProcedureStatuses
Schema
A schema describes the fields and data types returned by a single record in a response. Each resource URI has corresponding schema description. Swagger interface available at the /api/odata/swagger endpoint.
Authentication
HTTP Basic Authentication
The HTTP Authorization request header can be used to provide credentials that authenticate a user agent with a server, allowing access to a protected resource.
Authorization: Basic <credentials>
Credentials – base64 encoded username:userToken
Where the userToken can be obtained on the VSA portal. It must have Data Warehouse API scope.
Example:
user2:$apr1$O04r.y2H$/vEkesPhVInBByJUkXitA/
Rest API Tools
There are many free REST API tools you can use to experiment with creating Kaseya Data Warehouse API requests and seeing the corresponding responses. Recommended tools include Postman, Fiddler and Swagger.io.
OData feed support
Business Intelligence (BI) platforms Microsoft PowerBI and Tableau have native OData support.
In This Chapter |
